generated-client | jellyfin-sdk-typescript

Index

Enumerations

Interfaces

Functions

Const ActivityLogApiAxiosParamCreator

ActivityLogApiAxiosParamCreator(configuration?: Configuration): { getLogEntries: (startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/activity-log-api.ts:29
ActivityLogApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getLogEntries: (startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: any) => Promise<RequestArgs> }
- getLogEntries: (startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: any) => Promise<RequestArgs>
  - - (startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets activity log entries.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional startIndex: number
      - Optional limit: number
      - Optional minDate: string
      - Optional hasUserId: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const ActivityLogApiFactory

ActivityLogApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getLogEntries: any }

- Defined in generated-client/api/activity-log-api.ts:117
ActivityLogApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getLogEntries: any }
- getLogEntries:function
  - getLogEntries(startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: any): AxiosPromise<ActivityLogEntryQueryResult>
  - - Defined in generated-client/api/activity-log-api.ts:130
    summary
    Gets activity log entries.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional startIndex: number
    - Optional limit: number
    - Optional minDate: string
    - Optional hasUserId: boolean
    - Optional options: any
    Returns AxiosPromise<ActivityLogEntryQueryResult>

Const ActivityLogApiFp

ActivityLogApiFp(configuration?: Configuration): { getLogEntries: any }

- Defined in generated-client/api/activity-log-api.ts:93
ActivityLogApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getLogEntries: any }
- getLogEntries:function
  - getLogEntries(startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActivityLogEntryQueryResult>>
  - - Defined in generated-client/api/activity-log-api.ts:106
    summary
    Gets activity log entries.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional startIndex: number
    - Optional limit: number
    - Optional minDate: string
    - Optional hasUserId: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActivityLogEntryQueryResult>>

Const ApiKeyApiAxiosParamCreator

ApiKeyApiAxiosParamCreator(configuration?: Configuration): { createKey: (app: string, options?: any) => Promise<RequestArgs>; getKeys: (options?: any) => Promise<RequestArgs>; revokeKey: (key: string, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/api-key-api.ts:29
ApiKeyApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { createKey: (app: string, options?: any) => Promise<RequestArgs>; getKeys: (options?: any) => Promise<RequestArgs>; revokeKey: (key: string, options?: any) => Promise<RequestArgs> }
- createKey: (app: string, options?: any) => Promise<RequestArgs>
  - - (app: string, options?: any): Promise<RequestArgs>
    - summary
      Create a new api key.
      
      throws
      {RequiredError}
      
      Parameters
      - app: string
        Name of the app using the authentication key.
      - options: any = {}
      Returns Promise<RequestArgs>
- getKeys: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Get all keys.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- revokeKey: (key: string, options?: any) => Promise<RequestArgs>
  - - (key: string, options?: any): Promise<RequestArgs>
    - summary
      Remove an api key.
      
      throws
      {RequiredError}
      
      Parameters
      - key: string
        The access token to delete.
      - options: any = {}
      Returns Promise<RequestArgs>

Const ApiKeyApiFactory

ApiKeyApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { createKey: any; getKeys: any; revokeKey: any }

- Defined in generated-client/api/api-key-api.ts:190
ApiKeyApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { createKey: any; getKeys: any; revokeKey: any }
- createKey:function
  - createKey(app: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/api-key-api.ts:200
    summary
    Create a new api key.
    
    throws
    {RequiredError}
    
    Parameters
    - app: string
      Name of the app using the authentication key.
    - Optional options: any
    Returns AxiosPromise<void>
- getKeys:function
  - getKeys(options?: any): AxiosPromise<AuthenticationInfoQueryResult>
  - - Defined in generated-client/api/api-key-api.ts:209
    summary
    Get all keys.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<AuthenticationInfoQueryResult>
- revokeKey:function
  - revokeKey(key: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/api-key-api.ts:219
    summary
    Remove an api key.
    
    throws
    {RequiredError}
    
    Parameters
    - key: string
      The access token to delete.
    - Optional options: any
    Returns AxiosPromise<void>

Const ApiKeyApiFp

ApiKeyApiFp(configuration?: Configuration): { createKey: any; getKeys: any; revokeKey: any }

- Defined in generated-client/api/api-key-api.ts:148
ApiKeyApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { createKey: any; getKeys: any; revokeKey: any }
- createKey:function
  - createKey(app: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/api-key-api.ts:158
    summary
    Create a new api key.
    
    throws
    {RequiredError}
    
    Parameters
    - app: string
      Name of the app using the authentication key.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getKeys:function
  - getKeys(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationInfoQueryResult>>
  - - Defined in generated-client/api/api-key-api.ts:168
    summary
    Get all keys.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationInfoQueryResult>>
- revokeKey:function
  - revokeKey(key: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/api-key-api.ts:179
    summary
    Remove an api key.
    
    throws
    {RequiredError}
    
    Parameters
    - key: string
      The access token to delete.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const ArtistsApiAxiosParamCreator

ArtistsApiAxiosParamCreator(configuration?: Configuration): { getAlbumArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getArtistByName: (name: string, userId?: string, options?: any) => Promise<RequestArgs>; getArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/artists-api.ts:37
ArtistsApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getAlbumArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getArtistByName: (name: string, userId?: string, options?: any) => Promise<RequestArgs>; getArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }
- getAlbumArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
  - - (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets all album artists from a given item, folder, or the entire library.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional minCommunityRating: number
      - Optional startIndex: number
      - Optional limit: number
      - Optional searchTerm: string
      - Optional parentId: string
      - Optional fields: ItemFields[]
      - Optional excludeItemTypes: string[]
      - Optional includeItemTypes: string[]
      - Optional filters: ItemFilter[]
      - Optional isFavorite: boolean
      - Optional mediaTypes: string[]
      - Optional genres: string[]
      - Optional genreIds: string[]
      - Optional officialRatings: string[]
      - Optional tags: string[]
      - Optional years: number[]
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional person: string
      - Optional personIds: string[]
      - Optional personTypes: string[]
      - Optional studios: string[]
      - Optional studioIds: string[]
      - Optional userId: string
      - Optional nameStartsWithOrGreater: string
      - Optional nameStartsWith: string
      - Optional nameLessThan: string
      - Optional enableImages: boolean
      - Optional enableTotalRecordCount: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getArtistByName: (name: string, userId?: string, options?: any) => Promise<RequestArgs>
  - - (name: string, userId?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets an artist by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Studio name.
      - Optional userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getArtists: (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
  - - (minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets all artists from a given item, folder, or the entire library.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional minCommunityRating: number
      - Optional startIndex: number
      - Optional limit: number
      - Optional searchTerm: string
      - Optional parentId: string
      - Optional fields: ItemFields[]
      - Optional excludeItemTypes: string[]
      - Optional includeItemTypes: string[]
      - Optional filters: ItemFilter[]
      - Optional isFavorite: boolean
      - Optional mediaTypes: string[]
      - Optional genres: string[]
      - Optional genreIds: string[]
      - Optional officialRatings: string[]
      - Optional tags: string[]
      - Optional years: number[]
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional person: string
      - Optional personIds: string[]
      - Optional personTypes: string[]
      - Optional studios: string[]
      - Optional studioIds: string[]
      - Optional userId: string
      - Optional nameStartsWithOrGreater: string
      - Optional nameStartsWith: string
      - Optional nameLessThan: string
      - Optional enableImages: boolean
      - Optional enableTotalRecordCount: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const ArtistsApiFactory

ArtistsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getAlbumArtists: any; getArtistByName: any; getArtists: any }

- Defined in generated-client/api/artists-api.ts:556
ArtistsApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getAlbumArtists: any; getArtistByName: any; getArtists: any }
- getAlbumArtists:function
  - getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/artists-api.ts:595
    summary
    Gets all album artists from a given item, folder, or the entire library.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional minCommunityRating: number
    - Optional startIndex: number
    - Optional limit: number
    - Optional searchTerm: string
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional filters: ItemFilter[]
    - Optional isFavorite: boolean
    - Optional mediaTypes: string[]
    - Optional genres: string[]
    - Optional genreIds: string[]
    - Optional officialRatings: string[]
    - Optional tags: string[]
    - Optional years: number[]
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional person: string
    - Optional personIds: string[]
    - Optional personTypes: string[]
    - Optional studios: string[]
    - Optional studioIds: string[]
    - Optional userId: string
    - Optional nameStartsWithOrGreater: string
    - Optional nameStartsWith: string
    - Optional nameLessThan: string
    - Optional enableImages: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getArtistByName:function
  - getArtistByName(name: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>
  - - Defined in generated-client/api/artists-api.ts:606
    summary
    Gets an artist by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Studio name.
    - Optional userId: string
    - Optional options: any
    Returns AxiosPromise<BaseItemDto>
- getArtists:function
  - getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/artists-api.ts:645
    summary
    Gets all artists from a given item, folder, or the entire library.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional minCommunityRating: number
    - Optional startIndex: number
    - Optional limit: number
    - Optional searchTerm: string
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional filters: ItemFilter[]
    - Optional isFavorite: boolean
    - Optional mediaTypes: string[]
    - Optional genres: string[]
    - Optional genreIds: string[]
    - Optional officialRatings: string[]
    - Optional tags: string[]
    - Optional years: number[]
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional person: string
    - Optional personIds: string[]
    - Optional personTypes: string[]
    - Optional studios: string[]
    - Optional studioIds: string[]
    - Optional userId: string
    - Optional nameStartsWithOrGreater: string
    - Optional nameStartsWith: string
    - Optional nameLessThan: string
    - Optional enableImages: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>

Const ArtistsApiFp

ArtistsApiFp(configuration?: Configuration): { getAlbumArtists: any; getArtistByName: any; getArtists: any }

- Defined in generated-client/api/artists-api.ts:454
ArtistsApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getAlbumArtists: any; getArtistByName: any; getArtists: any }
- getAlbumArtists:function
  - getAlbumArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/artists-api.ts:493
    summary
    Gets all album artists from a given item, folder, or the entire library.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional minCommunityRating: number
    - Optional startIndex: number
    - Optional limit: number
    - Optional searchTerm: string
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional filters: ItemFilter[]
    - Optional isFavorite: boolean
    - Optional mediaTypes: string[]
    - Optional genres: string[]
    - Optional genreIds: string[]
    - Optional officialRatings: string[]
    - Optional tags: string[]
    - Optional years: number[]
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional person: string
    - Optional personIds: string[]
    - Optional personTypes: string[]
    - Optional studios: string[]
    - Optional studioIds: string[]
    - Optional userId: string
    - Optional nameStartsWithOrGreater: string
    - Optional nameStartsWith: string
    - Optional nameLessThan: string
    - Optional enableImages: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getArtistByName:function
  - getArtistByName(name: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
  - - Defined in generated-client/api/artists-api.ts:505
    summary
    Gets an artist by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Studio name.
    - Optional userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
- getArtists:function
  - getArtists(minCommunityRating?: number, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], genres?: string[], genreIds?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], studioIds?: string[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/artists-api.ts:545
    summary
    Gets all artists from a given item, folder, or the entire library.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional minCommunityRating: number
    - Optional startIndex: number
    - Optional limit: number
    - Optional searchTerm: string
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional filters: ItemFilter[]
    - Optional isFavorite: boolean
    - Optional mediaTypes: string[]
    - Optional genres: string[]
    - Optional genreIds: string[]
    - Optional officialRatings: string[]
    - Optional tags: string[]
    - Optional years: number[]
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional person: string
    - Optional personIds: string[]
    - Optional personTypes: string[]
    - Optional studios: string[]
    - Optional studioIds: string[]
    - Optional userId: string
    - Optional nameStartsWithOrGreater: string
    - Optional nameStartsWith: string
    - Optional nameLessThan: string
    - Optional enableImages: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>

Const AudioApiAxiosParamCreator

AudioApiAxiosParamCreator(configuration?: Configuration): { getAudioStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getAudioStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headAudioStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headAudioStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/audio-api.ts:31
AudioApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getAudioStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getAudioStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headAudioStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headAudioStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs> }
- getAudioStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
  - - (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
    - summary
      Gets an audio stream.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional container: string
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional mediaSourceId: string
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getAudioStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
  - - (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
    - summary
      Gets an audio stream.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - container: string
        The audio container.
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional mediaSourceId: string
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - options: any = {}
      Returns Promise<RequestArgs>
- headAudioStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
  - - (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
    - summary
      Gets an audio stream.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional container: string
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional mediaSourceId: string
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - options: any = {}
      Returns Promise<RequestArgs>
- headAudioStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
  - - (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
    - summary
      Gets an audio stream.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - container: string
        The audio container.
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional mediaSourceId: string
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - options: any = {}
      Returns Promise<RequestArgs>

Const AudioApiFactory

AudioApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getAudioStream: any; getAudioStreamByContainer: any; headAudioStream: any; headAudioStreamByContainer: any }

- Defined in generated-client/api/audio-api.ts:1380
AudioApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getAudioStream: any; getAudioStreamByContainer: any; headAudioStream: any; headAudioStreamByContainer: any }
- getAudioStream:function
  - getAudioStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/audio-api.ts:1438
    summary
    Gets an audio stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional container: string
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns AxiosPromise<any>
- getAudioStreamByContainer:function
  - getAudioStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/audio-api.ts:1496
    summary
    Gets an audio stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - container: string
      The audio container.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns AxiosPromise<any>
- headAudioStream:function
  - headAudioStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/audio-api.ts:1554
    summary
    Gets an audio stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional container: string
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns AxiosPromise<any>
- headAudioStreamByContainer:function
  - headAudioStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/audio-api.ts:1612
    summary
    Gets an audio stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - container: string
      The audio container.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns AxiosPromise<any>

Const AudioApiFp

AudioApiFp(configuration?: Configuration): { getAudioStream: any; getAudioStreamByContainer: any; headAudioStream: any; headAudioStreamByContainer: any }

- Defined in generated-client/api/audio-api.ts:1134
AudioApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getAudioStream: any; getAudioStreamByContainer: any; headAudioStream: any; headAudioStreamByContainer: any }
- getAudioStream:function
  - getAudioStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/audio-api.ts:1192
    summary
    Gets an audio stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional container: string
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getAudioStreamByContainer:function
  - getAudioStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/audio-api.ts:1251
    summary
    Gets an audio stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - container: string
      The audio container.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headAudioStream:function
  - headAudioStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/audio-api.ts:1310
    summary
    Gets an audio stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional container: string
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headAudioStreamByContainer:function
  - headAudioStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/audio-api.ts:1369
    summary
    Gets an audio stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - container: string
      The audio container.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

Const BrandingApiAxiosParamCreator

BrandingApiAxiosParamCreator(configuration?: Configuration): { getBrandingCss: (options?: any) => Promise<RequestArgs>; getBrandingCss2: (options?: any) => Promise<RequestArgs>; getBrandingOptions: (options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/branding-api.ts:29
BrandingApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getBrandingCss: (options?: any) => Promise<RequestArgs>; getBrandingCss2: (options?: any) => Promise<RequestArgs>; getBrandingOptions: (options?: any) => Promise<RequestArgs> }
- getBrandingCss: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets branding css.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getBrandingCss2: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets branding css.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getBrandingOptions: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets branding configuration.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>

Const BrandingApiFactory

BrandingApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getBrandingCss: any; getBrandingCss2: any; getBrandingOptions: any }

- Defined in generated-client/api/branding-api.ts:168
BrandingApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getBrandingCss: any; getBrandingCss2: any; getBrandingOptions: any }
- getBrandingCss:function
  - getBrandingCss(options?: any): AxiosPromise<string>
  - - Defined in generated-client/api/branding-api.ts:177
    summary
    Gets branding css.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<string>
- getBrandingCss2:function
  - getBrandingCss2(options?: any): AxiosPromise<string>
  - - Defined in generated-client/api/branding-api.ts:186
    summary
    Gets branding css.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<string>
- getBrandingOptions:function
  - getBrandingOptions(options?: any): AxiosPromise<BrandingOptions>
  - - Defined in generated-client/api/branding-api.ts:195
    summary
    Gets branding configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<BrandingOptions>

Const BrandingApiFp

BrandingApiFp(configuration?: Configuration): { getBrandingCss: any; getBrandingCss2: any; getBrandingOptions: any }

- Defined in generated-client/api/branding-api.ts:128
BrandingApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getBrandingCss: any; getBrandingCss2: any; getBrandingOptions: any }
- getBrandingCss:function
  - getBrandingCss(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
  - - Defined in generated-client/api/branding-api.ts:137
    summary
    Gets branding css.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
- getBrandingCss2:function
  - getBrandingCss2(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
  - - Defined in generated-client/api/branding-api.ts:147
    summary
    Gets branding css.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
- getBrandingOptions:function
  - getBrandingOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrandingOptions>>
  - - Defined in generated-client/api/branding-api.ts:157
    summary
    Gets branding configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BrandingOptions>>

Const ChannelsApiAxiosParamCreator

ChannelsApiAxiosParamCreator(configuration?: Configuration): { getAllChannelFeatures: (options?: any) => Promise<RequestArgs>; getChannelFeatures: (channelId: string, options?: any) => Promise<RequestArgs>; getChannelItems: (channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: SortOrder[], filters?: ItemFilter[], sortBy?: string[], fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getChannels: (userId?: string, startIndex?: number, limit?: number, supportsLatestItems?: boolean, supportsMediaDeletion?: boolean, isFavorite?: boolean, options?: any) => Promise<RequestArgs>; getLatestChannelItems: (userId?: string, startIndex?: number, limit?: number, filters?: ItemFilter[], fields?: ItemFields[], channelIds?: string[], options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/channels-api.ts:37
ChannelsApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getAllChannelFeatures: (options?: any) => Promise<RequestArgs>; getChannelFeatures: (channelId: string, options?: any) => Promise<RequestArgs>; getChannelItems: (channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: SortOrder[], filters?: ItemFilter[], sortBy?: string[], fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getChannels: (userId?: string, startIndex?: number, limit?: number, supportsLatestItems?: boolean, supportsMediaDeletion?: boolean, isFavorite?: boolean, options?: any) => Promise<RequestArgs>; getLatestChannelItems: (userId?: string, startIndex?: number, limit?: number, filters?: ItemFilter[], fields?: ItemFields[], channelIds?: string[], options?: any) => Promise<RequestArgs> }
- getAllChannelFeatures: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Get all channel features.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getChannelFeatures: (channelId: string, options?: any) => Promise<RequestArgs>
  - - (channelId: string, options?: any): Promise<RequestArgs>
    - summary
      Get channel features.
      
      throws
      {RequiredError}
      
      Parameters
      - channelId: string
        Channel id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getChannelItems: (channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: SortOrder[], filters?: ItemFilter[], sortBy?: string[], fields?: ItemFields[], options?: any) => Promise<RequestArgs>
  - - (channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: SortOrder[], filters?: ItemFilter[], sortBy?: string[], fields?: ItemFields[], options?: any): Promise<RequestArgs>
    - summary
      Get channel items.
      
      throws
      {RequiredError}
      
      Parameters
      - channelId: string
        Channel Id.
      - Optional folderId: string
      - Optional userId: string
      - Optional startIndex: number
      - Optional limit: number
      - Optional sortOrder: SortOrder[]
      - Optional filters: ItemFilter[]
      - Optional sortBy: string[]
      - Optional fields: ItemFields[]
      - options: any = {}
      Returns Promise<RequestArgs>
- getChannels: (userId?: string, startIndex?: number, limit?: number, supportsLatestItems?: boolean, supportsMediaDeletion?: boolean, isFavorite?: boolean, options?: any) => Promise<RequestArgs>
  - - (userId?: string, startIndex?: number, limit?: number, supportsLatestItems?: boolean, supportsMediaDeletion?: boolean, isFavorite?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets available channels.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional userId: string
      - Optional startIndex: number
      - Optional limit: number
      - Optional supportsLatestItems: boolean
      - Optional supportsMediaDeletion: boolean
      - Optional isFavorite: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getLatestChannelItems: (userId?: string, startIndex?: number, limit?: number, filters?: ItemFilter[], fields?: ItemFields[], channelIds?: string[], options?: any) => Promise<RequestArgs>
  - - (userId?: string, startIndex?: number, limit?: number, filters?: ItemFilter[], fields?: ItemFields[], channelIds?: string[], options?: any): Promise<RequestArgs>
    - summary
      Gets latest channel items.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional userId: string
      - Optional startIndex: number
      - Optional limit: number
      - Optional filters: ItemFilter[]
      - Optional fields: ItemFields[]
      - Optional channelIds: string[]
      - options: any = {}
      Returns Promise<RequestArgs>

Const ChannelsApiFactory

ChannelsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getAllChannelFeatures: any; getChannelFeatures: any; getChannelItems: any; getChannels: any; getLatestChannelItems: any }

- Defined in generated-client/api/channels-api.ts:401
ChannelsApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getAllChannelFeatures: any; getChannelFeatures: any; getChannelItems: any; getChannels: any; getLatestChannelItems: any }
- getAllChannelFeatures:function
  - getAllChannelFeatures(options?: any): AxiosPromise<ChannelFeatures[]>
  - - Defined in generated-client/api/channels-api.ts:410
    summary
    Get all channel features.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<ChannelFeatures[]>
- getChannelFeatures:function
  - getChannelFeatures(channelId: string, options?: any): AxiosPromise<ChannelFeatures>
  - - Defined in generated-client/api/channels-api.ts:420
    summary
    Get channel features.
    
    throws
    {RequiredError}
    
    Parameters
    - channelId: string
      Channel id.
    - Optional options: any
    Returns AxiosPromise<ChannelFeatures>
- getChannelItems:function
  - getChannelItems(channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: SortOrder[], filters?: ItemFilter[], sortBy?: string[], fields?: ItemFields[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/channels-api.ts:438
    summary
    Get channel items.
    
    throws
    {RequiredError}
    
    Parameters
    - channelId: string
      Channel Id.
    - Optional folderId: string
    - Optional userId: string
    - Optional startIndex: number
    - Optional limit: number
    - Optional sortOrder: SortOrder[]
    - Optional filters: ItemFilter[]
    - Optional sortBy: string[]
    - Optional fields: ItemFields[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getChannels:function
  - getChannels(userId?: string, startIndex?: number, limit?: number, supportsLatestItems?: boolean, supportsMediaDeletion?: boolean, isFavorite?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/channels-api.ts:453
    summary
    Gets available channels.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional startIndex: number
    - Optional limit: number
    - Optional supportsLatestItems: boolean
    - Optional supportsMediaDeletion: boolean
    - Optional isFavorite: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getLatestChannelItems:function
  - getLatestChannelItems(userId?: string, startIndex?: number, limit?: number, filters?: ItemFilter[], fields?: ItemFields[], channelIds?: string[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/channels-api.ts:468
    summary
    Gets latest channel items.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional startIndex: number
    - Optional limit: number
    - Optional filters: ItemFilter[]
    - Optional fields: ItemFields[]
    - Optional channelIds: string[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>

Const ChannelsApiFp

ChannelsApiFp(configuration?: Configuration): { getAllChannelFeatures: any; getChannelFeatures: any; getChannelItems: any; getChannels: any; getLatestChannelItems: any }

- Defined in generated-client/api/channels-api.ts:319
ChannelsApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getAllChannelFeatures: any; getChannelFeatures: any; getChannelItems: any; getChannels: any; getLatestChannelItems: any }
- getAllChannelFeatures:function
  - getAllChannelFeatures(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelFeatures[]>>
  - - Defined in generated-client/api/channels-api.ts:328
    summary
    Get all channel features.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelFeatures[]>>
- getChannelFeatures:function
  - getChannelFeatures(channelId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelFeatures>>
  - - Defined in generated-client/api/channels-api.ts:339
    summary
    Get channel features.
    
    throws
    {RequiredError}
    
    Parameters
    - channelId: string
      Channel id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelFeatures>>
- getChannelItems:function
  - getChannelItems(channelId: string, folderId?: string, userId?: string, startIndex?: number, limit?: number, sortOrder?: SortOrder[], filters?: ItemFilter[], sortBy?: string[], fields?: ItemFields[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/channels-api.ts:358
    summary
    Get channel items.
    
    throws
    {RequiredError}
    
    Parameters
    - channelId: string
      Channel Id.
    - Optional folderId: string
    - Optional userId: string
    - Optional startIndex: number
    - Optional limit: number
    - Optional sortOrder: SortOrder[]
    - Optional filters: ItemFilter[]
    - Optional sortBy: string[]
    - Optional fields: ItemFields[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getChannels:function
  - getChannels(userId?: string, startIndex?: number, limit?: number, supportsLatestItems?: boolean, supportsMediaDeletion?: boolean, isFavorite?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/channels-api.ts:374
    summary
    Gets available channels.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional startIndex: number
    - Optional limit: number
    - Optional supportsLatestItems: boolean
    - Optional supportsMediaDeletion: boolean
    - Optional isFavorite: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getLatestChannelItems:function
  - getLatestChannelItems(userId?: string, startIndex?: number, limit?: number, filters?: ItemFilter[], fields?: ItemFields[], channelIds?: string[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/channels-api.ts:390
    summary
    Gets latest channel items.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional startIndex: number
    - Optional limit: number
    - Optional filters: ItemFilter[]
    - Optional fields: ItemFields[]
    - Optional channelIds: string[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>

Const CollectionApiAxiosParamCreator

CollectionApiAxiosParamCreator(configuration?: Configuration): { addToCollection: (collectionId: string, ids: string[], options?: any) => Promise<RequestArgs>; createCollection: (name?: string, ids?: string[], parentId?: string, isLocked?: boolean, options?: any) => Promise<RequestArgs>; removeFromCollection: (collectionId: string, ids: string[], options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/collection-api.ts:29
CollectionApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { addToCollection: (collectionId: string, ids: string[], options?: any) => Promise<RequestArgs>; createCollection: (name?: string, ids?: string[], parentId?: string, isLocked?: boolean, options?: any) => Promise<RequestArgs>; removeFromCollection: (collectionId: string, ids: string[], options?: any) => Promise<RequestArgs> }
- addToCollection: (collectionId: string, ids: string[], options?: any) => Promise<RequestArgs>
  - - (collectionId: string, ids: string[], options?: any): Promise<RequestArgs>
    - summary
      Adds items to a collection.
      
      throws
      {RequiredError}
      
      Parameters
      - collectionId: string
        The collection id.
      - ids: string[]
        Item ids, comma delimited.
      - options: any = {}
      Returns Promise<RequestArgs>
- createCollection: (name?: string, ids?: string[], parentId?: string, isLocked?: boolean, options?: any) => Promise<RequestArgs>
  - - (name?: string, ids?: string[], parentId?: string, isLocked?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Creates a new collection.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional name: string
      - Optional ids: string[]
      - Optional parentId: string
      - Optional isLocked: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- removeFromCollection: (collectionId: string, ids: string[], options?: any) => Promise<RequestArgs>
  - - (collectionId: string, ids: string[], options?: any): Promise<RequestArgs>
    - summary
      Removes items from a collection.
      
      throws
      {RequiredError}
      
      Parameters
      - collectionId: string
        The collection id.
      - ids: string[]
        Item ids, comma delimited.
      - options: any = {}
      Returns Promise<RequestArgs>

Const CollectionApiFactory

CollectionApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { addToCollection: any; createCollection: any; removeFromCollection: any }

- Defined in generated-client/api/collection-api.ts:227
CollectionApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { addToCollection: any; createCollection: any; removeFromCollection: any }
- addToCollection:function
  - addToCollection(collectionId: string, ids: string[], options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/collection-api.ts:238
    summary
    Adds items to a collection.
    
    throws
    {RequiredError}
    
    Parameters
    - collectionId: string
      The collection id.
    - ids: string[]
      Item ids, comma delimited.
    - Optional options: any
    Returns AxiosPromise<void>
- createCollection:function
  - createCollection(name?: string, ids?: string[], parentId?: string, isLocked?: boolean, options?: any): AxiosPromise<CollectionCreationResult>
  - - Defined in generated-client/api/collection-api.ts:251
    summary
    Creates a new collection.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional name: string
    - Optional ids: string[]
    - Optional parentId: string
    - Optional isLocked: boolean
    - Optional options: any
    Returns AxiosPromise<CollectionCreationResult>
- removeFromCollection:function
  - removeFromCollection(collectionId: string, ids: string[], options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/collection-api.ts:262
    summary
    Removes items from a collection.
    
    throws
    {RequiredError}
    
    Parameters
    - collectionId: string
      The collection id.
    - ids: string[]
      Item ids, comma delimited.
    - Optional options: any
    Returns AxiosPromise<void>

Const CollectionApiFp

CollectionApiFp(configuration?: Configuration): { addToCollection: any; createCollection: any; removeFromCollection: any }

- Defined in generated-client/api/collection-api.ts:179
CollectionApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { addToCollection: any; createCollection: any; removeFromCollection: any }
- addToCollection:function
  - addToCollection(collectionId: string, ids: string[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/collection-api.ts:190
    summary
    Adds items to a collection.
    
    throws
    {RequiredError}
    
    Parameters
    - collectionId: string
      The collection id.
    - ids: string[]
      Item ids, comma delimited.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- createCollection:function
  - createCollection(name?: string, ids?: string[], parentId?: string, isLocked?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollectionCreationResult>>
  - - Defined in generated-client/api/collection-api.ts:204
    summary
    Creates a new collection.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional name: string
    - Optional ids: string[]
    - Optional parentId: string
    - Optional isLocked: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CollectionCreationResult>>
- removeFromCollection:function
  - removeFromCollection(collectionId: string, ids: string[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/collection-api.ts:216
    summary
    Removes items from a collection.
    
    throws
    {RequiredError}
    
    Parameters
    - collectionId: string
      The collection id.
    - ids: string[]
      Item ids, comma delimited.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const ConfigurationApiAxiosParamCreator

ConfigurationApiAxiosParamCreator(configuration?: Configuration): { getConfiguration: (options?: any) => Promise<RequestArgs>; getDefaultMetadataOptions: (options?: any) => Promise<RequestArgs>; getNamedConfiguration: (key: string, options?: any) => Promise<RequestArgs>; updateConfiguration: (serverConfiguration: ServerConfiguration, options?: any) => Promise<RequestArgs>; updateMediaEncoderPath: (mediaEncoderPathDto: MediaEncoderPathDto, options?: any) => Promise<RequestArgs>; updateNamedConfiguration: (key: string, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/configuration-api.ts:33
ConfigurationApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getConfiguration: (options?: any) => Promise<RequestArgs>; getDefaultMetadataOptions: (options?: any) => Promise<RequestArgs>; getNamedConfiguration: (key: string, options?: any) => Promise<RequestArgs>; updateConfiguration: (serverConfiguration: ServerConfiguration, options?: any) => Promise<RequestArgs>; updateMediaEncoderPath: (mediaEncoderPathDto: MediaEncoderPathDto, options?: any) => Promise<RequestArgs>; updateNamedConfiguration: (key: string, options?: any) => Promise<RequestArgs> }
- getConfiguration: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets application configuration.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getDefaultMetadataOptions: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets a default MetadataOptions object.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getNamedConfiguration: (key: string, options?: any) => Promise<RequestArgs>
  - - (key: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a named configuration.
      
      throws
      {RequiredError}
      
      Parameters
      - key: string
        Configuration key.
      - options: any = {}
      Returns Promise<RequestArgs>
- updateConfiguration: (serverConfiguration: ServerConfiguration, options?: any) => Promise<RequestArgs>
  - - (serverConfiguration: ServerConfiguration, options?: any): Promise<RequestArgs>
    - summary
      Updates application configuration.
      
      throws
      {RequiredError}
      
      Parameters
      - serverConfiguration: ServerConfiguration
        Configuration.
      - options: any = {}
      Returns Promise<RequestArgs>
- updateMediaEncoderPath: (mediaEncoderPathDto: MediaEncoderPathDto, options?: any) => Promise<RequestArgs>
  - - (mediaEncoderPathDto: MediaEncoderPathDto, options?: any): Promise<RequestArgs>
    - summary
      Updates the path to the media encoder.
      
      throws
      {RequiredError}
      
      Parameters
      - mediaEncoderPathDto: MediaEncoderPathDto
        Media encoder path form body.
      - options: any = {}
      Returns Promise<RequestArgs>
- updateNamedConfiguration: (key: string, options?: any) => Promise<RequestArgs>
  - - (key: string, options?: any): Promise<RequestArgs>
    - summary
      Updates named configuration.
      
      throws
      {RequiredError}
      
      Parameters
      - key: string
        Configuration key.
      - options: any = {}
      Returns Promise<RequestArgs>

Const ConfigurationApiFactory

ConfigurationApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getConfiguration: any; getDefaultMetadataOptions: any; getNamedConfiguration: any; updateConfiguration: any; updateMediaEncoderPath: any; updateNamedConfiguration: any }

- Defined in generated-client/api/configuration-api.ts:334
ConfigurationApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getConfiguration: any; getDefaultMetadataOptions: any; getNamedConfiguration: any; updateConfiguration: any; updateMediaEncoderPath: any; updateNamedConfiguration: any }
- getConfiguration:function
  - getConfiguration(options?: any): AxiosPromise<ServerConfiguration>
  - - Defined in generated-client/api/configuration-api.ts:343
    summary
    Gets application configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<ServerConfiguration>
- getDefaultMetadataOptions:function
  - getDefaultMetadataOptions(options?: any): AxiosPromise<MetadataOptions>
  - - Defined in generated-client/api/configuration-api.ts:352
    summary
    Gets a default MetadataOptions object.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<MetadataOptions>
- getNamedConfiguration:function
  - getNamedConfiguration(key: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/configuration-api.ts:362
    summary
    Gets a named configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - key: string
      Configuration key.
    - Optional options: any
    Returns AxiosPromise<any>
- updateConfiguration:function
  - updateConfiguration(serverConfiguration: ServerConfiguration, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/configuration-api.ts:372
    summary
    Updates application configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - serverConfiguration: ServerConfiguration
      Configuration.
    - Optional options: any
    Returns AxiosPromise<void>
- updateMediaEncoderPath:function
  - updateMediaEncoderPath(mediaEncoderPathDto: MediaEncoderPathDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/configuration-api.ts:382
    summary
    Updates the path to the media encoder.
    
    throws
    {RequiredError}
    
    Parameters
    - mediaEncoderPathDto: MediaEncoderPathDto
      Media encoder path form body.
    - Optional options: any
    Returns AxiosPromise<void>
- updateNamedConfiguration:function
  - updateNamedConfiguration(key: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/configuration-api.ts:392
    summary
    Updates named configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - key: string
      Configuration key.
    - Optional options: any
    Returns AxiosPromise<void>

Const ConfigurationApiFp

ConfigurationApiFp(configuration?: Configuration): { getConfiguration: any; getDefaultMetadataOptions: any; getNamedConfiguration: any; updateConfiguration: any; updateMediaEncoderPath: any; updateNamedConfiguration: any }

- Defined in generated-client/api/configuration-api.ts:260
ConfigurationApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getConfiguration: any; getDefaultMetadataOptions: any; getNamedConfiguration: any; updateConfiguration: any; updateMediaEncoderPath: any; updateNamedConfiguration: any }
- getConfiguration:function
  - getConfiguration(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerConfiguration>>
  - - Defined in generated-client/api/configuration-api.ts:269
    summary
    Gets application configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServerConfiguration>>
- getDefaultMetadataOptions:function
  - getDefaultMetadataOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataOptions>>
  - - Defined in generated-client/api/configuration-api.ts:279
    summary
    Gets a default MetadataOptions object.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataOptions>>
- getNamedConfiguration:function
  - getNamedConfiguration(key: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/configuration-api.ts:290
    summary
    Gets a named configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - key: string
      Configuration key.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- updateConfiguration:function
  - updateConfiguration(serverConfiguration: ServerConfiguration, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/configuration-api.ts:301
    summary
    Updates application configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - serverConfiguration: ServerConfiguration
      Configuration.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- updateMediaEncoderPath:function
  - updateMediaEncoderPath(mediaEncoderPathDto: MediaEncoderPathDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/configuration-api.ts:312
    summary
    Updates the path to the media encoder.
    
    throws
    {RequiredError}
    
    Parameters
    - mediaEncoderPathDto: MediaEncoderPathDto
      Media encoder path form body.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- updateNamedConfiguration:function
  - updateNamedConfiguration(key: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/configuration-api.ts:323
    summary
    Updates named configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - key: string
      Configuration key.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const DashboardApiAxiosParamCreator

DashboardApiAxiosParamCreator(configuration?: Configuration): { getConfigurationPages: (enableInMainMenu?: boolean, pageType?: ConfigurationPageType, options?: any) => Promise<RequestArgs>; getDashboardConfigurationPage: (name?: string, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/dashboard-api.ts:33
DashboardApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getConfigurationPages: (enableInMainMenu?: boolean, pageType?: ConfigurationPageType, options?: any) => Promise<RequestArgs>; getDashboardConfigurationPage: (name?: string, options?: any) => Promise<RequestArgs> }
- getConfigurationPages: (enableInMainMenu?: boolean, pageType?: ConfigurationPageType, options?: any) => Promise<RequestArgs>
  - - (enableInMainMenu?: boolean, pageType?: ConfigurationPageType, options?: any): Promise<RequestArgs>
    - summary
      Gets the configuration pages.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional enableInMainMenu: boolean
      - Optional pageType: ConfigurationPageType
      - options: any = {}
      Returns Promise<RequestArgs>
- getDashboardConfigurationPage: (name?: string, options?: any) => Promise<RequestArgs>
  - - (name?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a dashboard configuration page.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional name: string
      - options: any = {}
      Returns Promise<RequestArgs>

Const DashboardApiFactory

DashboardApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getConfigurationPages: any; getDashboardConfigurationPage: any }

- Defined in generated-client/api/dashboard-api.ts:150
DashboardApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getConfigurationPages: any; getDashboardConfigurationPage: any }
- getConfigurationPages:function
  - getConfigurationPages(enableInMainMenu?: boolean, pageType?: ConfigurationPageType, options?: any): AxiosPromise<ConfigurationPageInfo[]>
  - - Defined in generated-client/api/dashboard-api.ts:161
    summary
    Gets the configuration pages.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional enableInMainMenu: boolean
    - Optional pageType: ConfigurationPageType
    - Optional options: any
    Returns AxiosPromise<ConfigurationPageInfo[]>
- getDashboardConfigurationPage:function
  - getDashboardConfigurationPage(name?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dashboard-api.ts:171
    summary
    Gets a dashboard configuration page.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional name: string
    - Optional options: any
    Returns AxiosPromise<any>

Const DashboardApiFp

DashboardApiFp(configuration?: Configuration): { getConfigurationPages: any; getDashboardConfigurationPage: any }

- Defined in generated-client/api/dashboard-api.ts:117
DashboardApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getConfigurationPages: any; getDashboardConfigurationPage: any }
- getConfigurationPages:function
  - getConfigurationPages(enableInMainMenu?: boolean, pageType?: ConfigurationPageType, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigurationPageInfo[]>>
  - - Defined in generated-client/api/dashboard-api.ts:128
    summary
    Gets the configuration pages.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional enableInMainMenu: boolean
    - Optional pageType: ConfigurationPageType
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigurationPageInfo[]>>
- getDashboardConfigurationPage:function
  - getDashboardConfigurationPage(name?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dashboard-api.ts:139
    summary
    Gets a dashboard configuration page.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional name: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

Const DevicesApiAxiosParamCreator

DevicesApiAxiosParamCreator(configuration?: Configuration): { deleteDevice: (id: string, options?: any) => Promise<RequestArgs>; getDeviceInfo: (id: string, options?: any) => Promise<RequestArgs>; getDeviceOptions: (id: string, options?: any) => Promise<RequestArgs>; getDevices: (supportsSync?: boolean, userId?: string, options?: any) => Promise<RequestArgs>; updateDeviceOptions: (id: string, deviceOptions: DeviceOptions, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/devices-api.ts:35
DevicesApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { deleteDevice: (id: string, options?: any) => Promise<RequestArgs>; getDeviceInfo: (id: string, options?: any) => Promise<RequestArgs>; getDeviceOptions: (id: string, options?: any) => Promise<RequestArgs>; getDevices: (supportsSync?: boolean, userId?: string, options?: any) => Promise<RequestArgs>; updateDeviceOptions: (id: string, deviceOptions: DeviceOptions, options?: any) => Promise<RequestArgs> }
- deleteDevice: (id: string, options?: any) => Promise<RequestArgs>
  - - (id: string, options?: any): Promise<RequestArgs>
    - summary
      Deletes a device.
      
      throws
      {RequiredError}
      
      Parameters
      - id: string
        Device Id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getDeviceInfo: (id: string, options?: any) => Promise<RequestArgs>
  - - (id: string, options?: any): Promise<RequestArgs>
    - summary
      Get info for a device.
      
      throws
      {RequiredError}
      
      Parameters
      - id: string
        Device Id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getDeviceOptions: (id: string, options?: any) => Promise<RequestArgs>
  - - (id: string, options?: any): Promise<RequestArgs>
    - summary
      Get options for a device.
      
      throws
      {RequiredError}
      
      Parameters
      - id: string
        Device Id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getDevices: (supportsSync?: boolean, userId?: string, options?: any) => Promise<RequestArgs>
  - - (supportsSync?: boolean, userId?: string, options?: any): Promise<RequestArgs>
    - summary
      Get Devices.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional supportsSync: boolean
      - Optional userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- updateDeviceOptions: (id: string, deviceOptions: DeviceOptions, options?: any) => Promise<RequestArgs>
  - - (id: string, deviceOptions: DeviceOptions, options?: any): Promise<RequestArgs>
    - summary
      Update device options.
      
      throws
      {RequiredError}
      
      Parameters
      - id: string
        Device Id.
      - deviceOptions: DeviceOptions
        Device Options.
      - options: any = {}
      Returns Promise<RequestArgs>

Const DevicesApiFactory

DevicesApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { deleteDevice: any; getDeviceInfo: any; getDeviceOptions: any; getDevices: any; updateDeviceOptions: any }

- Defined in generated-client/api/devices-api.ts:320
DevicesApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { deleteDevice: any; getDeviceInfo: any; getDeviceOptions: any; getDevices: any; updateDeviceOptions: any }
- deleteDevice:function
  - deleteDevice(id: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/devices-api.ts:330
    summary
    Deletes a device.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      Device Id.
    - Optional options: any
    Returns AxiosPromise<void>
- getDeviceInfo:function
  - getDeviceInfo(id: string, options?: any): AxiosPromise<DeviceInfo>
  - - Defined in generated-client/api/devices-api.ts:340
    summary
    Get info for a device.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      Device Id.
    - Optional options: any
    Returns AxiosPromise<DeviceInfo>
- getDeviceOptions:function
  - getDeviceOptions(id: string, options?: any): AxiosPromise<DeviceOptions>
  - - Defined in generated-client/api/devices-api.ts:350
    summary
    Get options for a device.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      Device Id.
    - Optional options: any
    Returns AxiosPromise<DeviceOptions>
- getDevices:function
  - getDevices(supportsSync?: boolean, userId?: string, options?: any): AxiosPromise<DeviceInfoQueryResult>
  - - Defined in generated-client/api/devices-api.ts:361
    summary
    Get Devices.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional supportsSync: boolean
    - Optional userId: string
    - Optional options: any
    Returns AxiosPromise<DeviceInfoQueryResult>
- updateDeviceOptions:function
  - updateDeviceOptions(id: string, deviceOptions: DeviceOptions, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/devices-api.ts:372
    summary
    Update device options.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      Device Id.
    - deviceOptions: DeviceOptions
      Device Options.
    - Optional options: any
    Returns AxiosPromise<void>

Const DevicesApiFp

DevicesApiFp(configuration?: Configuration): { deleteDevice: any; getDeviceInfo: any; getDeviceOptions: any; getDevices: any; updateDeviceOptions: any }

- Defined in generated-client/api/devices-api.ts:253
DevicesApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { deleteDevice: any; getDeviceInfo: any; getDeviceOptions: any; getDevices: any; updateDeviceOptions: any }
- deleteDevice:function
  - deleteDevice(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/devices-api.ts:263
    summary
    Deletes a device.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      Device Id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getDeviceInfo:function
  - getDeviceInfo(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfo>>
  - - Defined in generated-client/api/devices-api.ts:274
    summary
    Get info for a device.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      Device Id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfo>>
- getDeviceOptions:function
  - getDeviceOptions(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceOptions>>
  - - Defined in generated-client/api/devices-api.ts:285
    summary
    Get options for a device.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      Device Id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceOptions>>
- getDevices:function
  - getDevices(supportsSync?: boolean, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoQueryResult>>
  - - Defined in generated-client/api/devices-api.ts:297
    summary
    Get Devices.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional supportsSync: boolean
    - Optional userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceInfoQueryResult>>
- updateDeviceOptions:function
  - updateDeviceOptions(id: string, deviceOptions: DeviceOptions, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/devices-api.ts:309
    summary
    Update device options.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      Device Id.
    - deviceOptions: DeviceOptions
      Device Options.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const DisplayPreferencesApiAxiosParamCreator

DisplayPreferencesApiAxiosParamCreator(configuration?: Configuration): { getDisplayPreferences: (displayPreferencesId: string, userId: string, client: string, options?: any) => Promise<RequestArgs>; updateDisplayPreferences: (displayPreferencesId: string, userId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/display-preferences-api.ts:29
DisplayPreferencesApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getDisplayPreferences: (displayPreferencesId: string, userId: string, client: string, options?: any) => Promise<RequestArgs>; updateDisplayPreferences: (displayPreferencesId: string, userId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, options?: any) => Promise<RequestArgs> }
- getDisplayPreferences: (displayPreferencesId: string, userId: string, client: string, options?: any) => Promise<RequestArgs>
  - - (displayPreferencesId: string, userId: string, client: string, options?: any): Promise<RequestArgs>
    - summary
      Get Display Preferences.
      
      throws
      {RequiredError}
      
      Parameters
      - displayPreferencesId: string
        Display preferences id.
      - userId: string
        User id.
      - client: string
        Client.
      - options: any = {}
      Returns Promise<RequestArgs>
- updateDisplayPreferences: (displayPreferencesId: string, userId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, options?: any) => Promise<RequestArgs>
  - - (displayPreferencesId: string, userId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, options?: any): Promise<RequestArgs>
    - summary
      Update Display Preferences.
      
      throws
      {RequiredError}
      
      Parameters
      - displayPreferencesId: string
        Display preferences id.
      - userId: string
        User Id.
      - client: string
        Client.
      - displayPreferencesDto: DisplayPreferencesDto
        New Display Preferences object.
      - options: any = {}
      Returns Promise<RequestArgs>

Const DisplayPreferencesApiFactory

DisplayPreferencesApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getDisplayPreferences: any; updateDisplayPreferences: any }

- Defined in generated-client/api/display-preferences-api.ts:183
DisplayPreferencesApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getDisplayPreferences: any; updateDisplayPreferences: any }
- getDisplayPreferences:function
  - getDisplayPreferences(displayPreferencesId: string, userId: string, client: string, options?: any): AxiosPromise<DisplayPreferencesDto>
  - - Defined in generated-client/api/display-preferences-api.ts:195
    summary
    Get Display Preferences.
    
    throws
    {RequiredError}
    
    Parameters
    - displayPreferencesId: string
      Display preferences id.
    - userId: string
      User id.
    - client: string
      Client.
    - Optional options: any
    Returns AxiosPromise<DisplayPreferencesDto>
- updateDisplayPreferences:function
  - updateDisplayPreferences(displayPreferencesId: string, userId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/display-preferences-api.ts:208
    summary
    Update Display Preferences.
    
    throws
    {RequiredError}
    
    Parameters
    - displayPreferencesId: string
      Display preferences id.
    - userId: string
      User Id.
    - client: string
      Client.
    - displayPreferencesDto: DisplayPreferencesDto
      New Display Preferences object.
    - Optional options: any
    Returns AxiosPromise<void>

Const DisplayPreferencesApiFp

DisplayPreferencesApiFp(configuration?: Configuration): { getDisplayPreferences: any; updateDisplayPreferences: any }

- Defined in generated-client/api/display-preferences-api.ts:146
DisplayPreferencesApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getDisplayPreferences: any; updateDisplayPreferences: any }
- getDisplayPreferences:function
  - getDisplayPreferences(displayPreferencesId: string, userId: string, client: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DisplayPreferencesDto>>
  - - Defined in generated-client/api/display-preferences-api.ts:158
    summary
    Get Display Preferences.
    
    throws
    {RequiredError}
    
    Parameters
    - displayPreferencesId: string
      Display preferences id.
    - userId: string
      User id.
    - client: string
      Client.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DisplayPreferencesDto>>
- updateDisplayPreferences:function
  - updateDisplayPreferences(displayPreferencesId: string, userId: string, client: string, displayPreferencesDto: DisplayPreferencesDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/display-preferences-api.ts:172
    summary
    Update Display Preferences.
    
    throws
    {RequiredError}
    
    Parameters
    - displayPreferencesId: string
      Display preferences id.
    - userId: string
      User Id.
    - client: string
      Client.
    - displayPreferencesDto: DisplayPreferencesDto
      New Display Preferences object.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const DlnaApiAxiosParamCreator

DlnaApiAxiosParamCreator(configuration?: Configuration): { createProfile: (deviceProfile?: DeviceProfile, options?: any) => Promise<RequestArgs>; deleteProfile: (profileId: string, options?: any) => Promise<RequestArgs>; getDefaultProfile: (options?: any) => Promise<RequestArgs>; getProfile: (profileId: string, options?: any) => Promise<RequestArgs>; getProfileInfos: (options?: any) => Promise<RequestArgs>; updateProfile: (profileId: string, deviceProfile?: DeviceProfile, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/dlna-api.ts:33
DlnaApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { createProfile: (deviceProfile?: DeviceProfile, options?: any) => Promise<RequestArgs>; deleteProfile: (profileId: string, options?: any) => Promise<RequestArgs>; getDefaultProfile: (options?: any) => Promise<RequestArgs>; getProfile: (profileId: string, options?: any) => Promise<RequestArgs>; getProfileInfos: (options?: any) => Promise<RequestArgs>; updateProfile: (profileId: string, deviceProfile?: DeviceProfile, options?: any) => Promise<RequestArgs> }
- createProfile: (deviceProfile?: DeviceProfile, options?: any) => Promise<RequestArgs>
  - - (deviceProfile?: DeviceProfile, options?: any): Promise<RequestArgs>
    - summary
      Creates a profile.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional deviceProfile: DeviceProfile
      - options: any = {}
      Returns Promise<RequestArgs>
- deleteProfile: (profileId: string, options?: any) => Promise<RequestArgs>
  - - (profileId: string, options?: any): Promise<RequestArgs>
    - summary
      Deletes a profile.
      
      throws
      {RequiredError}
      
      Parameters
      - profileId: string
        Profile id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getDefaultProfile: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets the default profile.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getProfile: (profileId: string, options?: any) => Promise<RequestArgs>
  - - (profileId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a single profile.
      
      throws
      {RequiredError}
      
      Parameters
      - profileId: string
        Profile Id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getProfileInfos: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Get profile infos.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- updateProfile: (profileId: string, deviceProfile?: DeviceProfile, options?: any) => Promise<RequestArgs>
  - - (profileId: string, deviceProfile?: DeviceProfile, options?: any): Promise<RequestArgs>
    - summary
      Updates a profile.
      
      throws
      {RequiredError}
      
      Parameters
      - profileId: string
        Profile id.
      - Optional deviceProfile: DeviceProfile
      - options: any = {}
      Returns Promise<RequestArgs>

Const DlnaApiFactory

DlnaApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { createProfile: any; deleteProfile: any; getDefaultProfile: any; getProfile: any; getProfileInfos: any; updateProfile: any }

- Defined in generated-client/api/dlna-api.ts:335
DlnaApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { createProfile: any; deleteProfile: any; getDefaultProfile: any; getProfile: any; getProfileInfos: any; updateProfile: any }
- createProfile:function
  - createProfile(deviceProfile?: DeviceProfile, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/dlna-api.ts:345
    summary
    Creates a profile.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional deviceProfile: DeviceProfile
    - Optional options: any
    Returns AxiosPromise<void>
- deleteProfile:function
  - deleteProfile(profileId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/dlna-api.ts:355
    summary
    Deletes a profile.
    
    throws
    {RequiredError}
    
    Parameters
    - profileId: string
      Profile id.
    - Optional options: any
    Returns AxiosPromise<void>
- getDefaultProfile:function
  - getDefaultProfile(options?: any): AxiosPromise<DeviceProfile>
  - - Defined in generated-client/api/dlna-api.ts:364
    summary
    Gets the default profile.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<DeviceProfile>
- getProfile:function
  - getProfile(profileId: string, options?: any): AxiosPromise<DeviceProfile>
  - - Defined in generated-client/api/dlna-api.ts:374
    summary
    Gets a single profile.
    
    throws
    {RequiredError}
    
    Parameters
    - profileId: string
      Profile Id.
    - Optional options: any
    Returns AxiosPromise<DeviceProfile>
- getProfileInfos:function
  - getProfileInfos(options?: any): AxiosPromise<DeviceProfileInfo[]>
  - - Defined in generated-client/api/dlna-api.ts:383
    summary
    Get profile infos.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<DeviceProfileInfo[]>
- updateProfile:function
  - updateProfile(profileId: string, deviceProfile?: DeviceProfile, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/dlna-api.ts:394
    summary
    Updates a profile.
    
    throws
    {RequiredError}
    
    Parameters
    - profileId: string
      Profile id.
    - Optional deviceProfile: DeviceProfile
    - Optional options: any
    Returns AxiosPromise<void>

Const DlnaApiFp

DlnaApiFp(configuration?: Configuration): { createProfile: any; deleteProfile: any; getDefaultProfile: any; getProfile: any; getProfileInfos: any; updateProfile: any }

- Defined in generated-client/api/dlna-api.ts:260
DlnaApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { createProfile: any; deleteProfile: any; getDefaultProfile: any; getProfile: any; getProfileInfos: any; updateProfile: any }
- createProfile:function
  - createProfile(deviceProfile?: DeviceProfile, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/dlna-api.ts:270
    summary
    Creates a profile.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional deviceProfile: DeviceProfile
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- deleteProfile:function
  - deleteProfile(profileId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/dlna-api.ts:281
    summary
    Deletes a profile.
    
    throws
    {RequiredError}
    
    Parameters
    - profileId: string
      Profile id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getDefaultProfile:function
  - getDefaultProfile(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceProfile>>
  - - Defined in generated-client/api/dlna-api.ts:291
    summary
    Gets the default profile.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceProfile>>
- getProfile:function
  - getProfile(profileId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceProfile>>
  - - Defined in generated-client/api/dlna-api.ts:302
    summary
    Gets a single profile.
    
    throws
    {RequiredError}
    
    Parameters
    - profileId: string
      Profile Id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceProfile>>
- getProfileInfos:function
  - getProfileInfos(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceProfileInfo[]>>
  - - Defined in generated-client/api/dlna-api.ts:312
    summary
    Get profile infos.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeviceProfileInfo[]>>
- updateProfile:function
  - updateProfile(profileId: string, deviceProfile?: DeviceProfile, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/dlna-api.ts:324
    summary
    Updates a profile.
    
    throws
    {RequiredError}
    
    Parameters
    - profileId: string
      Profile id.
    - Optional deviceProfile: DeviceProfile
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const DlnaServerApiAxiosParamCreator

DlnaServerApiAxiosParamCreator(configuration?: Configuration): { getConnectionManager: (serverId: string, options?: any) => Promise<RequestArgs>; getConnectionManager2: (serverId: string, options?: any) => Promise<RequestArgs>; getConnectionManager3: (serverId: string, options?: any) => Promise<RequestArgs>; getContentDirectory: (serverId: string, options?: any) => Promise<RequestArgs>; getContentDirectory2: (serverId: string, options?: any) => Promise<RequestArgs>; getContentDirectory3: (serverId: string, options?: any) => Promise<RequestArgs>; getDescriptionXml: (serverId: string, options?: any) => Promise<RequestArgs>; getDescriptionXml2: (serverId: string, options?: any) => Promise<RequestArgs>; getIcon: (fileName: string, options?: any) => Promise<RequestArgs>; getIconId: (serverId: string, fileName: string, options?: any) => Promise<RequestArgs>; getMediaReceiverRegistrar: (serverId: string, options?: any) => Promise<RequestArgs>; getMediaReceiverRegistrar2: (serverId: string, options?: any) => Promise<RequestArgs>; getMediaReceiverRegistrar3: (serverId: string, options?: any) => Promise<RequestArgs>; processConnectionManagerControlRequest: (serverId: string, options?: any) => Promise<RequestArgs>; processContentDirectoryControlRequest: (serverId: string, options?: any) => Promise<RequestArgs>; processMediaReceiverRegistrarControlRequest: (serverId: string, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/dlna-server-api.ts:29
DlnaServerApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getConnectionManager: (serverId: string, options?: any) => Promise<RequestArgs>; getConnectionManager2: (serverId: string, options?: any) => Promise<RequestArgs>; getConnectionManager3: (serverId: string, options?: any) => Promise<RequestArgs>; getContentDirectory: (serverId: string, options?: any) => Promise<RequestArgs>; getContentDirectory2: (serverId: string, options?: any) => Promise<RequestArgs>; getContentDirectory3: (serverId: string, options?: any) => Promise<RequestArgs>; getDescriptionXml: (serverId: string, options?: any) => Promise<RequestArgs>; getDescriptionXml2: (serverId: string, options?: any) => Promise<RequestArgs>; getIcon: (fileName: string, options?: any) => Promise<RequestArgs>; getIconId: (serverId: string, fileName: string, options?: any) => Promise<RequestArgs>; getMediaReceiverRegistrar: (serverId: string, options?: any) => Promise<RequestArgs>; getMediaReceiverRegistrar2: (serverId: string, options?: any) => Promise<RequestArgs>; getMediaReceiverRegistrar3: (serverId: string, options?: any) => Promise<RequestArgs>; processConnectionManagerControlRequest: (serverId: string, options?: any) => Promise<RequestArgs>; processContentDirectoryControlRequest: (serverId: string, options?: any) => Promise<RequestArgs>; processMediaReceiverRegistrarControlRequest: (serverId: string, options?: any) => Promise<RequestArgs> }
- getConnectionManager: (serverId: string, options?: any) => Promise<RequestArgs>
  - - (serverId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets Dlna media receiver registrar xml.
      
      throws
      {RequiredError}
      
      Parameters
      - serverId: string
        Server UUID.
      - options: any = {}
      Returns Promise<RequestArgs>
- getConnectionManager2: (serverId: string, options?: any) => Promise<RequestArgs>
  - - (serverId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets Dlna media receiver registrar xml.
      
      throws
      {RequiredError}
      
      Parameters
      - serverId: string
        Server UUID.
      - options: any = {}
      Returns Promise<RequestArgs>
- getConnectionManager3: (serverId: string, options?: any) => Promise<RequestArgs>
  - - (serverId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets Dlna media receiver registrar xml.
      
      throws
      {RequiredError}
      
      Parameters
      - serverId: string
        Server UUID.
      - options: any = {}
      Returns Promise<RequestArgs>
- getContentDirectory: (serverId: string, options?: any) => Promise<RequestArgs>
  - - (serverId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets Dlna content directory xml.
      
      throws
      {RequiredError}
      
      Parameters
      - serverId: string
        Server UUID.
      - options: any = {}
      Returns Promise<RequestArgs>
- getContentDirectory2: (serverId: string, options?: any) => Promise<RequestArgs>
  - - (serverId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets Dlna content directory xml.
      
      throws
      {RequiredError}
      
      Parameters
      - serverId: string
        Server UUID.
      - options: any = {}
      Returns Promise<RequestArgs>
- getContentDirectory3: (serverId: string, options?: any) => Promise<RequestArgs>
  - - (serverId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets Dlna content directory xml.
      
      throws
      {RequiredError}
      
      Parameters
      - serverId: string
        Server UUID.
      - options: any = {}
      Returns Promise<RequestArgs>
- getDescriptionXml: (serverId: string, options?: any) => Promise<RequestArgs>
  - - (serverId: string, options?: any): Promise<RequestArgs>
    - summary
      Get Description Xml.
      
      throws
      {RequiredError}
      
      Parameters
      - serverId: string
        Server UUID.
      - options: any = {}
      Returns Promise<RequestArgs>
- getDescriptionXml2: (serverId: string, options?: any) => Promise<RequestArgs>
  - - (serverId: string, options?: any): Promise<RequestArgs>
    - summary
      Get Description Xml.
      
      throws
      {RequiredError}
      
      Parameters
      - serverId: string
        Server UUID.
      - options: any = {}
      Returns Promise<RequestArgs>
- getIcon: (fileName: string, options?: any) => Promise<RequestArgs>
  - - (fileName: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a server icon.
      
      throws
      {RequiredError}
      
      Parameters
      - fileName: string
        The icon filename.
      - options: any = {}
      Returns Promise<RequestArgs>
- getIconId: (serverId: string, fileName: string, options?: any) => Promise<RequestArgs>
  - - (serverId: string, fileName: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a server icon.
      
      throws
      {RequiredError}
      
      Parameters
      - serverId: string
        Server UUID.
      - fileName: string
        The icon filename.
      - options: any = {}
      Returns Promise<RequestArgs>
- getMediaReceiverRegistrar: (serverId: string, options?: any) => Promise<RequestArgs>
  - - (serverId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets Dlna media receiver registrar xml.
      
      throws
      {RequiredError}
      
      Parameters
      - serverId: string
        Server UUID.
      - options: any = {}
      Returns Promise<RequestArgs>
- getMediaReceiverRegistrar2: (serverId: string, options?: any) => Promise<RequestArgs>
  - - (serverId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets Dlna media receiver registrar xml.
      
      throws
      {RequiredError}
      
      Parameters
      - serverId: string
        Server UUID.
      - options: any = {}
      Returns Promise<RequestArgs>
- getMediaReceiverRegistrar3: (serverId: string, options?: any) => Promise<RequestArgs>
  - - (serverId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets Dlna media receiver registrar xml.
      
      throws
      {RequiredError}
      
      Parameters
      - serverId: string
        Server UUID.
      - options: any = {}
      Returns Promise<RequestArgs>
- processConnectionManagerControlRequest: (serverId: string, options?: any) => Promise<RequestArgs>
  - - (serverId: string, options?: any): Promise<RequestArgs>
    - summary
      Process a connection manager control request.
      
      throws
      {RequiredError}
      
      Parameters
      - serverId: string
        Server UUID.
      - options: any = {}
      Returns Promise<RequestArgs>
- processContentDirectoryControlRequest: (serverId: string, options?: any) => Promise<RequestArgs>
  - - (serverId: string, options?: any): Promise<RequestArgs>
    - summary
      Process a content directory control request.
      
      throws
      {RequiredError}
      
      Parameters
      - serverId: string
        Server UUID.
      - options: any = {}
      Returns Promise<RequestArgs>
- processMediaReceiverRegistrarControlRequest: (serverId: string, options?: any) => Promise<RequestArgs>
  - - (serverId: string, options?: any): Promise<RequestArgs>
    - summary
      Process a media receiver registrar control request.
      
      throws
      {RequiredError}
      
      Parameters
      - serverId: string
        Server UUID.
      - options: any = {}
      Returns Promise<RequestArgs>

Const DlnaServerApiFactory

DlnaServerApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getConnectionManager: any; getConnectionManager2: any; getConnectionManager3: any; getContentDirectory: any; getContentDirectory2: any; getContentDirectory3: any; getDescriptionXml: any; getDescriptionXml2: any; getIcon: any; getIconId: any; getMediaReceiverRegistrar: any; getMediaReceiverRegistrar2: any; getMediaReceiverRegistrar3: any; processConnectionManagerControlRequest: any; processContentDirectoryControlRequest: any; processMediaReceiverRegistrarControlRequest: any }

- Defined in generated-client/api/dlna-server-api.ts:773
DlnaServerApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getConnectionManager: any; getConnectionManager2: any; getConnectionManager3: any; getContentDirectory: any; getContentDirectory2: any; getContentDirectory3: any; getDescriptionXml: any; getDescriptionXml2: any; getIcon: any; getIconId: any; getMediaReceiverRegistrar: any; getMediaReceiverRegistrar2: any; getMediaReceiverRegistrar3: any; processConnectionManagerControlRequest: any; processContentDirectoryControlRequest: any; processMediaReceiverRegistrarControlRequest: any }
- getConnectionManager:function
  - getConnectionManager(serverId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dlna-server-api.ts:783
    summary
    Gets Dlna media receiver registrar xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns AxiosPromise<any>
- getConnectionManager2:function
  - getConnectionManager2(serverId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dlna-server-api.ts:793
    summary
    Gets Dlna media receiver registrar xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns AxiosPromise<any>
- getConnectionManager3:function
  - getConnectionManager3(serverId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dlna-server-api.ts:803
    summary
    Gets Dlna media receiver registrar xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns AxiosPromise<any>
- getContentDirectory:function
  - getContentDirectory(serverId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dlna-server-api.ts:813
    summary
    Gets Dlna content directory xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns AxiosPromise<any>
- getContentDirectory2:function
  - getContentDirectory2(serverId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dlna-server-api.ts:823
    summary
    Gets Dlna content directory xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns AxiosPromise<any>
- getContentDirectory3:function
  - getContentDirectory3(serverId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dlna-server-api.ts:833
    summary
    Gets Dlna content directory xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns AxiosPromise<any>
- getDescriptionXml:function
  - getDescriptionXml(serverId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dlna-server-api.ts:843
    summary
    Get Description Xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns AxiosPromise<any>
- getDescriptionXml2:function
  - getDescriptionXml2(serverId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dlna-server-api.ts:853
    summary
    Get Description Xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns AxiosPromise<any>
- getIcon:function
  - getIcon(fileName: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dlna-server-api.ts:863
    summary
    Gets a server icon.
    
    throws
    {RequiredError}
    
    Parameters
    - fileName: string
      The icon filename.
    - Optional options: any
    Returns AxiosPromise<any>
- getIconId:function
  - getIconId(serverId: string, fileName: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dlna-server-api.ts:874
    summary
    Gets a server icon.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - fileName: string
      The icon filename.
    - Optional options: any
    Returns AxiosPromise<any>
- getMediaReceiverRegistrar:function
  - getMediaReceiverRegistrar(serverId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dlna-server-api.ts:884
    summary
    Gets Dlna media receiver registrar xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns AxiosPromise<any>
- getMediaReceiverRegistrar2:function
  - getMediaReceiverRegistrar2(serverId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dlna-server-api.ts:894
    summary
    Gets Dlna media receiver registrar xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns AxiosPromise<any>
- getMediaReceiverRegistrar3:function
  - getMediaReceiverRegistrar3(serverId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dlna-server-api.ts:904
    summary
    Gets Dlna media receiver registrar xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns AxiosPromise<any>
- processConnectionManagerControlRequest:function
  - processConnectionManagerControlRequest(serverId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dlna-server-api.ts:914
    summary
    Process a connection manager control request.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns AxiosPromise<any>
- processContentDirectoryControlRequest:function
  - processContentDirectoryControlRequest(serverId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dlna-server-api.ts:924
    summary
    Process a content directory control request.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns AxiosPromise<any>
- processMediaReceiverRegistrarControlRequest:function
  - processMediaReceiverRegistrarControlRequest(serverId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dlna-server-api.ts:934
    summary
    Process a media receiver registrar control request.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns AxiosPromise<any>

Const DlnaServerApiFp

DlnaServerApiFp(configuration?: Configuration): { getConnectionManager: any; getConnectionManager2: any; getConnectionManager3: any; getContentDirectory: any; getContentDirectory2: any; getContentDirectory3: any; getDescriptionXml: any; getDescriptionXml2: any; getIcon: any; getIconId: any; getMediaReceiverRegistrar: any; getMediaReceiverRegistrar2: any; getMediaReceiverRegistrar3: any; processConnectionManagerControlRequest: any; processContentDirectoryControlRequest: any; processMediaReceiverRegistrarControlRequest: any }

- Defined in generated-client/api/dlna-server-api.ts:586
DlnaServerApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getConnectionManager: any; getConnectionManager2: any; getConnectionManager3: any; getContentDirectory: any; getContentDirectory2: any; getContentDirectory3: any; getDescriptionXml: any; getDescriptionXml2: any; getIcon: any; getIconId: any; getMediaReceiverRegistrar: any; getMediaReceiverRegistrar2: any; getMediaReceiverRegistrar3: any; processConnectionManagerControlRequest: any; processContentDirectoryControlRequest: any; processMediaReceiverRegistrarControlRequest: any }
- getConnectionManager:function
  - getConnectionManager(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dlna-server-api.ts:596
    summary
    Gets Dlna media receiver registrar xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getConnectionManager2:function
  - getConnectionManager2(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dlna-server-api.ts:607
    summary
    Gets Dlna media receiver registrar xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getConnectionManager3:function
  - getConnectionManager3(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dlna-server-api.ts:618
    summary
    Gets Dlna media receiver registrar xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getContentDirectory:function
  - getContentDirectory(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dlna-server-api.ts:629
    summary
    Gets Dlna content directory xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getContentDirectory2:function
  - getContentDirectory2(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dlna-server-api.ts:640
    summary
    Gets Dlna content directory xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getContentDirectory3:function
  - getContentDirectory3(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dlna-server-api.ts:651
    summary
    Gets Dlna content directory xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getDescriptionXml:function
  - getDescriptionXml(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dlna-server-api.ts:662
    summary
    Get Description Xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getDescriptionXml2:function
  - getDescriptionXml2(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dlna-server-api.ts:673
    summary
    Get Description Xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getIcon:function
  - getIcon(fileName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dlna-server-api.ts:684
    summary
    Gets a server icon.
    
    throws
    {RequiredError}
    
    Parameters
    - fileName: string
      The icon filename.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getIconId:function
  - getIconId(serverId: string, fileName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dlna-server-api.ts:696
    summary
    Gets a server icon.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - fileName: string
      The icon filename.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getMediaReceiverRegistrar:function
  - getMediaReceiverRegistrar(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dlna-server-api.ts:707
    summary
    Gets Dlna media receiver registrar xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getMediaReceiverRegistrar2:function
  - getMediaReceiverRegistrar2(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dlna-server-api.ts:718
    summary
    Gets Dlna media receiver registrar xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getMediaReceiverRegistrar3:function
  - getMediaReceiverRegistrar3(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dlna-server-api.ts:729
    summary
    Gets Dlna media receiver registrar xml.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- processConnectionManagerControlRequest:function
  - processConnectionManagerControlRequest(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dlna-server-api.ts:740
    summary
    Process a connection manager control request.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- processContentDirectoryControlRequest:function
  - processContentDirectoryControlRequest(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dlna-server-api.ts:751
    summary
    Process a content directory control request.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- processMediaReceiverRegistrarControlRequest:function
  - processMediaReceiverRegistrarControlRequest(serverId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dlna-server-api.ts:762
    summary
    Process a media receiver registrar control request.
    
    throws
    {RequiredError}
    
    Parameters
    - serverId: string
      Server UUID.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

Const DynamicHlsApiAxiosParamCreator

DynamicHlsApiAxiosParamCreator(configuration?: Configuration): { getHlsAudioSegment: (itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getHlsVideoSegment: (itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getMasterHlsAudioPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>; getMasterHlsVideoPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>; getVariantHlsAudioPlaylist: (itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getVariantHlsVideoPlaylist: (itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headMasterHlsAudioPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>; headMasterHlsVideoPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/dynamic-hls-api.ts:31
DynamicHlsApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getHlsAudioSegment: (itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getHlsVideoSegment: (itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getMasterHlsAudioPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>; getMasterHlsVideoPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>; getVariantHlsAudioPlaylist: (itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getVariantHlsVideoPlaylist: (itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headMasterHlsAudioPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>; headMasterHlsVideoPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs> }
- getHlsAudioSegment: (itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
  - - (itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
    - summary
      Gets a video stream using HTTP live streaming.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - playlistId: string
        The playlist id.
      - segmentId: number
        The segment id.
      - container: string
        The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional mediaSourceId: string
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional maxStreamingBitrate: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getHlsVideoSegment: (itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
  - - (itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
    - summary
      Gets a video stream using HTTP live streaming.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - playlistId: string
        The playlist id.
      - segmentId: number
        The segment id.
      - container: string
        The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional mediaSourceId: string
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getMasterHlsAudioPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>
  - - (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets an audio hls playlist stream.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - mediaSourceId: string
        The media version id, if playing an alternate version.
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional maxStreamingBitrate: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - Optional enableAdaptiveBitrateStreaming: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getMasterHlsVideoPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>
  - - (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets a video hls playlist stream.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - mediaSourceId: string
        The media version id, if playing an alternate version.
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - Optional enableAdaptiveBitrateStreaming: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getVariantHlsAudioPlaylist: (itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
  - - (itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
    - summary
      Gets an audio stream using HTTP live streaming.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional mediaSourceId: string
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional maxStreamingBitrate: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getVariantHlsVideoPlaylist: (itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
  - - (itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
    - summary
      Gets a video stream using HTTP live streaming.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional mediaSourceId: string
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - options: any = {}
      Returns Promise<RequestArgs>
- headMasterHlsAudioPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>
  - - (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets an audio hls playlist stream.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - mediaSourceId: string
        The media version id, if playing an alternate version.
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional maxStreamingBitrate: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - Optional enableAdaptiveBitrateStreaming: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- headMasterHlsVideoPlaylist: (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any) => Promise<RequestArgs>
  - - (itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets a video hls playlist stream.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - mediaSourceId: string
        The media version id, if playing an alternate version.
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - Optional enableAdaptiveBitrateStreaming: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const DynamicHlsApiFactory

DynamicHlsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getHlsAudioSegment: any; getHlsVideoSegment: any; getMasterHlsAudioPlaylist: any; getMasterHlsVideoPlaylist: any; getVariantHlsAudioPlaylist: any; getVariantHlsVideoPlaylist: any; headMasterHlsAudioPlaylist: any; headMasterHlsVideoPlaylist: any }

- Defined in generated-client/api/dynamic-hls-api.ts:2776
DynamicHlsApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getHlsAudioSegment: any; getHlsVideoSegment: any; getMasterHlsAudioPlaylist: any; getMasterHlsVideoPlaylist: any; getVariantHlsAudioPlaylist: any; getVariantHlsVideoPlaylist: any; headMasterHlsAudioPlaylist: any; headMasterHlsVideoPlaylist: any }
- getHlsAudioSegment:function
  - getHlsAudioSegment(itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dynamic-hls-api.ts:2837
    summary
    Gets a video stream using HTTP live streaming.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - playlistId: string
      The playlist id.
    - segmentId: number
      The segment id.
    - container: string
      The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional maxStreamingBitrate: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns AxiosPromise<any>
- getHlsVideoSegment:function
  - getHlsVideoSegment(itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dynamic-hls-api.ts:2897
    summary
    Gets a video stream using HTTP live streaming.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - playlistId: string
      The playlist id.
    - segmentId: number
      The segment id.
    - container: string
      The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns AxiosPromise<any>
- getMasterHlsAudioPlaylist:function
  - getMasterHlsAudioPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dynamic-hls-api.ts:2956
    summary
    Gets an audio hls playlist stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - mediaSourceId: string
      The media version id, if playing an alternate version.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional maxStreamingBitrate: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional enableAdaptiveBitrateStreaming: boolean
    - Optional options: any
    Returns AxiosPromise<any>
- getMasterHlsVideoPlaylist:function
  - getMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dynamic-hls-api.ts:3014
    summary
    Gets a video hls playlist stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - mediaSourceId: string
      The media version id, if playing an alternate version.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional enableAdaptiveBitrateStreaming: boolean
    - Optional options: any
    Returns AxiosPromise<any>
- getVariantHlsAudioPlaylist:function
  - getVariantHlsAudioPlaylist(itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dynamic-hls-api.ts:3072
    summary
    Gets an audio stream using HTTP live streaming.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional maxStreamingBitrate: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns AxiosPromise<any>
- getVariantHlsVideoPlaylist:function
  - getVariantHlsVideoPlaylist(itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dynamic-hls-api.ts:3129
    summary
    Gets a video stream using HTTP live streaming.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns AxiosPromise<any>
- headMasterHlsAudioPlaylist:function
  - headMasterHlsAudioPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dynamic-hls-api.ts:3188
    summary
    Gets an audio hls playlist stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - mediaSourceId: string
      The media version id, if playing an alternate version.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional maxStreamingBitrate: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional enableAdaptiveBitrateStreaming: boolean
    - Optional options: any
    Returns AxiosPromise<any>
- headMasterHlsVideoPlaylist:function
  - headMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/dynamic-hls-api.ts:3246
    summary
    Gets a video hls playlist stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - mediaSourceId: string
      The media version id, if playing an alternate version.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional enableAdaptiveBitrateStreaming: boolean
    - Optional options: any
    Returns AxiosPromise<any>

Const DynamicHlsApiFp

DynamicHlsApiFp(configuration?: Configuration): { getHlsAudioSegment: any; getHlsVideoSegment: any; getMasterHlsAudioPlaylist: any; getMasterHlsVideoPlaylist: any; getVariantHlsAudioPlaylist: any; getVariantHlsVideoPlaylist: any; headMasterHlsAudioPlaylist: any; headMasterHlsVideoPlaylist: any }

- Defined in generated-client/api/dynamic-hls-api.ts:2288
DynamicHlsApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getHlsAudioSegment: any; getHlsVideoSegment: any; getMasterHlsAudioPlaylist: any; getMasterHlsVideoPlaylist: any; getVariantHlsAudioPlaylist: any; getVariantHlsVideoPlaylist: any; headMasterHlsAudioPlaylist: any; headMasterHlsVideoPlaylist: any }
- getHlsAudioSegment:function
  - getHlsAudioSegment(itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dynamic-hls-api.ts:2349
    summary
    Gets a video stream using HTTP live streaming.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - playlistId: string
      The playlist id.
    - segmentId: number
      The segment id.
    - container: string
      The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional maxStreamingBitrate: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getHlsVideoSegment:function
  - getHlsVideoSegment(itemId: string, playlistId: string, segmentId: number, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dynamic-hls-api.ts:2410
    summary
    Gets a video stream using HTTP live streaming.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - playlistId: string
      The playlist id.
    - segmentId: number
      The segment id.
    - container: string
      The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getMasterHlsAudioPlaylist:function
  - getMasterHlsAudioPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dynamic-hls-api.ts:2470
    summary
    Gets an audio hls playlist stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - mediaSourceId: string
      The media version id, if playing an alternate version.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional maxStreamingBitrate: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional enableAdaptiveBitrateStreaming: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getMasterHlsVideoPlaylist:function
  - getMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dynamic-hls-api.ts:2529
    summary
    Gets a video hls playlist stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - mediaSourceId: string
      The media version id, if playing an alternate version.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional enableAdaptiveBitrateStreaming: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getVariantHlsAudioPlaylist:function
  - getVariantHlsAudioPlaylist(itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dynamic-hls-api.ts:2588
    summary
    Gets an audio stream using HTTP live streaming.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional maxStreamingBitrate: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getVariantHlsVideoPlaylist:function
  - getVariantHlsVideoPlaylist(itemId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dynamic-hls-api.ts:2646
    summary
    Gets a video stream using HTTP live streaming.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headMasterHlsAudioPlaylist:function
  - headMasterHlsAudioPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, maxStreamingBitrate?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dynamic-hls-api.ts:2706
    summary
    Gets an audio hls playlist stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - mediaSourceId: string
      The media version id, if playing an alternate version.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional maxStreamingBitrate: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional enableAdaptiveBitrateStreaming: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headMasterHlsVideoPlaylist:function
  - headMasterHlsVideoPlaylist(itemId: string, mediaSourceId: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, enableAdaptiveBitrateStreaming?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/dynamic-hls-api.ts:2765
    summary
    Gets a video hls playlist stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - mediaSourceId: string
      The media version id, if playing an alternate version.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional enableAdaptiveBitrateStreaming: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

Const EnvironmentApiAxiosParamCreator

EnvironmentApiAxiosParamCreator(configuration?: Configuration): { getDefaultDirectoryBrowser: (options?: any) => Promise<RequestArgs>; getDirectoryContents: (path: string, includeFiles?: boolean, includeDirectories?: boolean, options?: any) => Promise<RequestArgs>; getDrives: (options?: any) => Promise<RequestArgs>; getNetworkShares: (options?: any) => Promise<RequestArgs>; getParentPath: (path: string, options?: any) => Promise<RequestArgs>; validatePath: (validatePathDto: ValidatePathDto, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/environment-api.ts:35
EnvironmentApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getDefaultDirectoryBrowser: (options?: any) => Promise<RequestArgs>; getDirectoryContents: (path: string, includeFiles?: boolean, includeDirectories?: boolean, options?: any) => Promise<RequestArgs>; getDrives: (options?: any) => Promise<RequestArgs>; getNetworkShares: (options?: any) => Promise<RequestArgs>; getParentPath: (path: string, options?: any) => Promise<RequestArgs>; validatePath: (validatePathDto: ValidatePathDto, options?: any) => Promise<RequestArgs> }
- getDefaultDirectoryBrowser: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Get Default directory browser.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getDirectoryContents: (path: string, includeFiles?: boolean, includeDirectories?: boolean, options?: any) => Promise<RequestArgs>
  - - (path: string, includeFiles?: boolean, includeDirectories?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets the contents of a given directory in the file system.
      
      throws
      {RequiredError}
      
      Parameters
      - path: string
        The path.
      - Optional includeFiles: boolean
      - Optional includeDirectories: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getDrives: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets available drives from the server's file system.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getNetworkShares: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets network paths.
      
      deprecated
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getParentPath: (path: string, options?: any) => Promise<RequestArgs>
  - - (path: string, options?: any): Promise<RequestArgs>
    - summary
      Gets the parent path of a given path.
      
      throws
      {RequiredError}
      
      Parameters
      - path: string
        The path.
      - options: any = {}
      Returns Promise<RequestArgs>
- validatePath: (validatePathDto: ValidatePathDto, options?: any) => Promise<RequestArgs>
  - - (validatePathDto: ValidatePathDto, options?: any): Promise<RequestArgs>
    - summary
      Validates path.
      
      throws
      {RequiredError}
      
      Parameters
      - validatePathDto: ValidatePathDto
        Validate request object.
      - options: any = {}
      Returns Promise<RequestArgs>

Const EnvironmentApiFactory

EnvironmentApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getDefaultDirectoryBrowser: any; getDirectoryContents: any; getDrives: any; getNetworkShares: any; getParentPath: any; validatePath: any }

- Defined in generated-client/api/environment-api.ts:349
EnvironmentApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getDefaultDirectoryBrowser: any; getDirectoryContents: any; getDrives: any; getNetworkShares: any; getParentPath: any; validatePath: any }
- getDefaultDirectoryBrowser:function
  - getDefaultDirectoryBrowser(options?: any): AxiosPromise<DefaultDirectoryBrowserInfoDto>
  - - Defined in generated-client/api/environment-api.ts:358
    summary
    Get Default directory browser.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<DefaultDirectoryBrowserInfoDto>
- getDirectoryContents:function
  - getDirectoryContents(path: string, includeFiles?: boolean, includeDirectories?: boolean, options?: any): AxiosPromise<FileSystemEntryInfo[]>
  - - Defined in generated-client/api/environment-api.ts:370
    summary
    Gets the contents of a given directory in the file system.
    
    throws
    {RequiredError}
    
    Parameters
    - path: string
      The path.
    - Optional includeFiles: boolean
    - Optional includeDirectories: boolean
    - Optional options: any
    Returns AxiosPromise<FileSystemEntryInfo[]>
- getDrives:function
  - getDrives(options?: any): AxiosPromise<FileSystemEntryInfo[]>
  - - Defined in generated-client/api/environment-api.ts:379
    summary
    Gets available drives from the server's file system.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<FileSystemEntryInfo[]>
- getNetworkShares:function
  - getNetworkShares(options?: any): AxiosPromise<FileSystemEntryInfo[]>
  - - Defined in generated-client/api/environment-api.ts:389
    summary
    Gets network paths.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<FileSystemEntryInfo[]>
- getParentPath:function
  - getParentPath(path: string, options?: any): AxiosPromise<string>
  - - Defined in generated-client/api/environment-api.ts:399
    summary
    Gets the parent path of a given path.
    
    throws
    {RequiredError}
    
    Parameters
    - path: string
      The path.
    - Optional options: any
    Returns AxiosPromise<string>
- validatePath:function
  - validatePath(validatePathDto: ValidatePathDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/environment-api.ts:409
    summary
    Validates path.
    
    throws
    {RequiredError}
    
    Parameters
    - validatePathDto: ValidatePathDto
      Validate request object.
    - Optional options: any
    Returns AxiosPromise<void>

Const EnvironmentApiFp

EnvironmentApiFp(configuration?: Configuration): { getDefaultDirectoryBrowser: any; getDirectoryContents: any; getDrives: any; getNetworkShares: any; getParentPath: any; validatePath: any }

- Defined in generated-client/api/environment-api.ts:273
EnvironmentApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getDefaultDirectoryBrowser: any; getDirectoryContents: any; getDrives: any; getNetworkShares: any; getParentPath: any; validatePath: any }
- getDefaultDirectoryBrowser:function
  - getDefaultDirectoryBrowser(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DefaultDirectoryBrowserInfoDto>>
  - - Defined in generated-client/api/environment-api.ts:282
    summary
    Get Default directory browser.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DefaultDirectoryBrowserInfoDto>>
- getDirectoryContents:function
  - getDirectoryContents(path: string, includeFiles?: boolean, includeDirectories?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileSystemEntryInfo[]>>
  - - Defined in generated-client/api/environment-api.ts:295
    summary
    Gets the contents of a given directory in the file system.
    
    throws
    {RequiredError}
    
    Parameters
    - path: string
      The path.
    - Optional includeFiles: boolean
    - Optional includeDirectories: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileSystemEntryInfo[]>>
- getDrives:function
  - getDrives(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileSystemEntryInfo[]>>
  - - Defined in generated-client/api/environment-api.ts:305
    summary
    Gets available drives from the server's file system.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileSystemEntryInfo[]>>
- getNetworkShares:function
  - getNetworkShares(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileSystemEntryInfo[]>>
  - - Defined in generated-client/api/environment-api.ts:316
    summary
    Gets network paths.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileSystemEntryInfo[]>>
- getParentPath:function
  - getParentPath(path: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
  - - Defined in generated-client/api/environment-api.ts:327
    summary
    Gets the parent path of a given path.
    
    throws
    {RequiredError}
    
    Parameters
    - path: string
      The path.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
- validatePath:function
  - validatePath(validatePathDto: ValidatePathDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/environment-api.ts:338
    summary
    Validates path.
    
    throws
    {RequiredError}
    
    Parameters
    - validatePathDto: ValidatePathDto
      Validate request object.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const FilterApiAxiosParamCreator

FilterApiAxiosParamCreator(configuration?: Configuration): { getQueryFilters: (userId?: string, parentId?: string, includeItemTypes?: string[], isAiring?: boolean, isMovie?: boolean, isSports?: boolean, isKids?: boolean, isNews?: boolean, isSeries?: boolean, recursive?: boolean, options?: any) => Promise<RequestArgs>; getQueryFiltersLegacy: (userId?: string, parentId?: string, includeItemTypes?: string[], mediaTypes?: string[], options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/filter-api.ts:31
FilterApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getQueryFilters: (userId?: string, parentId?: string, includeItemTypes?: string[], isAiring?: boolean, isMovie?: boolean, isSports?: boolean, isKids?: boolean, isNews?: boolean, isSeries?: boolean, recursive?: boolean, options?: any) => Promise<RequestArgs>; getQueryFiltersLegacy: (userId?: string, parentId?: string, includeItemTypes?: string[], mediaTypes?: string[], options?: any) => Promise<RequestArgs> }
- getQueryFilters: (userId?: string, parentId?: string, includeItemTypes?: string[], isAiring?: boolean, isMovie?: boolean, isSports?: boolean, isKids?: boolean, isNews?: boolean, isSeries?: boolean, recursive?: boolean, options?: any) => Promise<RequestArgs>
  - - (userId?: string, parentId?: string, includeItemTypes?: string[], isAiring?: boolean, isMovie?: boolean, isSports?: boolean, isKids?: boolean, isNews?: boolean, isSeries?: boolean, recursive?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets query filters.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional userId: string
      - Optional parentId: string
      - Optional includeItemTypes: string[]
      - Optional isAiring: boolean
      - Optional isMovie: boolean
      - Optional isSports: boolean
      - Optional isKids: boolean
      - Optional isNews: boolean
      - Optional isSeries: boolean
      - Optional recursive: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getQueryFiltersLegacy: (userId?: string, parentId?: string, includeItemTypes?: string[], mediaTypes?: string[], options?: any) => Promise<RequestArgs>
  - - (userId?: string, parentId?: string, includeItemTypes?: string[], mediaTypes?: string[], options?: any): Promise<RequestArgs>
    - summary
      Gets legacy query filters.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional userId: string
      - Optional parentId: string
      - Optional includeItemTypes: string[]
      - Optional mediaTypes: string[]
      - options: any = {}
      Returns Promise<RequestArgs>

Const FilterApiFactory

FilterApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getQueryFilters: any; getQueryFiltersLegacy: any }

- Defined in generated-client/api/filter-api.ts:220
FilterApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getQueryFilters: any; getQueryFiltersLegacy: any }
- getQueryFilters:function
  - getQueryFilters(userId?: string, parentId?: string, includeItemTypes?: string[], isAiring?: boolean, isMovie?: boolean, isSports?: boolean, isKids?: boolean, isNews?: boolean, isSeries?: boolean, recursive?: boolean, options?: any): AxiosPromise<QueryFilters>
  - - Defined in generated-client/api/filter-api.ts:239
    summary
    Gets query filters.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional parentId: string
    - Optional includeItemTypes: string[]
    - Optional isAiring: boolean
    - Optional isMovie: boolean
    - Optional isSports: boolean
    - Optional isKids: boolean
    - Optional isNews: boolean
    - Optional isSeries: boolean
    - Optional recursive: boolean
    - Optional options: any
    Returns AxiosPromise<QueryFilters>
- getQueryFiltersLegacy:function
  - getQueryFiltersLegacy(userId?: string, parentId?: string, includeItemTypes?: string[], mediaTypes?: string[], options?: any): AxiosPromise<QueryFiltersLegacy>
  - - Defined in generated-client/api/filter-api.ts:252
    summary
    Gets legacy query filters.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional parentId: string
    - Optional includeItemTypes: string[]
    - Optional mediaTypes: string[]
    - Optional options: any
    Returns AxiosPromise<QueryFiltersLegacy>

Const FilterApiFp

FilterApiFp(configuration?: Configuration): { getQueryFilters: any; getQueryFiltersLegacy: any }

- Defined in generated-client/api/filter-api.ts:176
FilterApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getQueryFilters: any; getQueryFiltersLegacy: any }
- getQueryFilters:function
  - getQueryFilters(userId?: string, parentId?: string, includeItemTypes?: string[], isAiring?: boolean, isMovie?: boolean, isSports?: boolean, isKids?: boolean, isNews?: boolean, isSeries?: boolean, recursive?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryFilters>>
  - - Defined in generated-client/api/filter-api.ts:195
    summary
    Gets query filters.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional parentId: string
    - Optional includeItemTypes: string[]
    - Optional isAiring: boolean
    - Optional isMovie: boolean
    - Optional isSports: boolean
    - Optional isKids: boolean
    - Optional isNews: boolean
    - Optional isSeries: boolean
    - Optional recursive: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryFilters>>
- getQueryFiltersLegacy:function
  - getQueryFiltersLegacy(userId?: string, parentId?: string, includeItemTypes?: string[], mediaTypes?: string[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryFiltersLegacy>>
  - - Defined in generated-client/api/filter-api.ts:209
    summary
    Gets legacy query filters.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional parentId: string
    - Optional includeItemTypes: string[]
    - Optional mediaTypes: string[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QueryFiltersLegacy>>

Const GenresApiAxiosParamCreator

GenresApiAxiosParamCreator(configuration?: Configuration): { getGenre: (genreName: string, userId?: string, options?: any) => Promise<RequestArgs>; getGenres: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/genres-api.ts:35
GenresApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getGenre: (genreName: string, userId?: string, options?: any) => Promise<RequestArgs>; getGenres: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }
- getGenre: (genreName: string, userId?: string, options?: any) => Promise<RequestArgs>
  - - (genreName: string, userId?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a genre, by name.
      
      throws
      {RequiredError}
      
      Parameters
      - genreName: string
        The genre name.
      - Optional userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getGenres: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
  - - (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets all genres from a given item, folder, or the entire library.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional startIndex: number
      - Optional limit: number
      - Optional searchTerm: string
      - Optional parentId: string
      - Optional fields: ItemFields[]
      - Optional excludeItemTypes: string[]
      - Optional includeItemTypes: string[]
      - Optional isFavorite: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional userId: string
      - Optional nameStartsWithOrGreater: string
      - Optional nameStartsWith: string
      - Optional nameLessThan: string
      - Optional enableImages: boolean
      - Optional enableTotalRecordCount: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const GenresApiFactory

GenresApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getGenre: any; getGenres: any }

- Defined in generated-client/api/genres-api.ts:247
GenresApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getGenre: any; getGenres: any }
- getGenre:function
  - getGenre(genreName: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>
  - - Defined in generated-client/api/genres-api.ts:258
    summary
    Gets a genre, by name.
    
    throws
    {RequiredError}
    
    Parameters
    - genreName: string
      The genre name.
    - Optional userId: string
    - Optional options: any
    Returns AxiosPromise<BaseItemDto>
- getGenres:function
  - getGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/genres-api.ts:283
    summary
    Gets all genres from a given item, folder, or the entire library.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional startIndex: number
    - Optional limit: number
    - Optional searchTerm: string
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional isFavorite: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional userId: string
    - Optional nameStartsWithOrGreater: string
    - Optional nameStartsWith: string
    - Optional nameLessThan: string
    - Optional enableImages: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>

Const GenresApiFp

GenresApiFp(configuration?: Configuration): { getGenre: any; getGenres: any }

- Defined in generated-client/api/genres-api.ts:199
GenresApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getGenre: any; getGenres: any }
- getGenre:function
  - getGenre(genreName: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
  - - Defined in generated-client/api/genres-api.ts:210
    summary
    Gets a genre, by name.
    
    throws
    {RequiredError}
    
    Parameters
    - genreName: string
      The genre name.
    - Optional userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
- getGenres:function
  - getGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/genres-api.ts:236
    summary
    Gets all genres from a given item, folder, or the entire library.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional startIndex: number
    - Optional limit: number
    - Optional searchTerm: string
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional isFavorite: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional userId: string
    - Optional nameStartsWithOrGreater: string
    - Optional nameStartsWith: string
    - Optional nameLessThan: string
    - Optional enableImages: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>

Const HlsSegmentApiAxiosParamCreator

HlsSegmentApiAxiosParamCreator(configuration?: Configuration): { getHlsAudioSegmentLegacyAac: (itemId: string, segmentId: string, options?: any) => Promise<RequestArgs>; getHlsAudioSegmentLegacyMp3: (itemId: string, segmentId: string, options?: any) => Promise<RequestArgs>; getHlsPlaylistLegacy: (itemId: string, playlistId: string, options?: any) => Promise<RequestArgs>; getHlsVideoSegmentLegacy: (itemId: string, playlistId: string, segmentId: string, segmentContainer: string, options?: any) => Promise<RequestArgs>; stopEncodingProcess: (deviceId: string, playSessionId: string, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/hls-segment-api.ts:29
HlsSegmentApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getHlsAudioSegmentLegacyAac: (itemId: string, segmentId: string, options?: any) => Promise<RequestArgs>; getHlsAudioSegmentLegacyMp3: (itemId: string, segmentId: string, options?: any) => Promise<RequestArgs>; getHlsPlaylistLegacy: (itemId: string, playlistId: string, options?: any) => Promise<RequestArgs>; getHlsVideoSegmentLegacy: (itemId: string, playlistId: string, segmentId: string, segmentContainer: string, options?: any) => Promise<RequestArgs>; stopEncodingProcess: (deviceId: string, playSessionId: string, options?: any) => Promise<RequestArgs> }
- getHlsAudioSegmentLegacyAac: (itemId: string, segmentId: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, segmentId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets the specified audio segment for an audio item.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - segmentId: string
        The segment id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getHlsAudioSegmentLegacyMp3: (itemId: string, segmentId: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, segmentId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets the specified audio segment for an audio item.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - segmentId: string
        The segment id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getHlsPlaylistLegacy: (itemId: string, playlistId: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, playlistId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a hls video playlist.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The video id.
      - playlistId: string
        The playlist id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getHlsVideoSegmentLegacy: (itemId: string, playlistId: string, segmentId: string, segmentContainer: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, playlistId: string, segmentId: string, segmentContainer: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a hls video segment.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - playlistId: string
        The playlist id.
      - segmentId: string
        The segment id.
      - segmentContainer: string
        The segment container.
      - options: any = {}
      Returns Promise<RequestArgs>
- stopEncodingProcess: (deviceId: string, playSessionId: string, options?: any) => Promise<RequestArgs>
  - - (deviceId: string, playSessionId: string, options?: any): Promise<RequestArgs>
    - summary
      Stops an active encoding.
      
      throws
      {RequiredError}
      
      Parameters
      - deviceId: string
        The device id of the client requesting. Used to stop encoding processes when needed.
      - playSessionId: string
        The play session id.
      - options: any = {}
      Returns Promise<RequestArgs>

Const HlsSegmentApiFactory

HlsSegmentApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getHlsAudioSegmentLegacyAac: any; getHlsAudioSegmentLegacyMp3: any; getHlsPlaylistLegacy: any; getHlsVideoSegmentLegacy: any; stopEncodingProcess: any }

- Defined in generated-client/api/hls-segment-api.ts:320
HlsSegmentApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getHlsAudioSegmentLegacyAac: any; getHlsAudioSegmentLegacyMp3: any; getHlsPlaylistLegacy: any; getHlsVideoSegmentLegacy: any; stopEncodingProcess: any }
- getHlsAudioSegmentLegacyAac:function
  - getHlsAudioSegmentLegacyAac(itemId: string, segmentId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/hls-segment-api.ts:331
    summary
    Gets the specified audio segment for an audio item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - segmentId: string
      The segment id.
    - Optional options: any
    Returns AxiosPromise<any>
- getHlsAudioSegmentLegacyMp3:function
  - getHlsAudioSegmentLegacyMp3(itemId: string, segmentId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/hls-segment-api.ts:342
    summary
    Gets the specified audio segment for an audio item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - segmentId: string
      The segment id.
    - Optional options: any
    Returns AxiosPromise<any>
- getHlsPlaylistLegacy:function
  - getHlsPlaylistLegacy(itemId: string, playlistId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/hls-segment-api.ts:353
    summary
    Gets a hls video playlist.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The video id.
    - playlistId: string
      The playlist id.
    - Optional options: any
    Returns AxiosPromise<any>
- getHlsVideoSegmentLegacy:function
  - getHlsVideoSegmentLegacy(itemId: string, playlistId: string, segmentId: string, segmentContainer: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/hls-segment-api.ts:366
    summary
    Gets a hls video segment.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - playlistId: string
      The playlist id.
    - segmentId: string
      The segment id.
    - segmentContainer: string
      The segment container.
    - Optional options: any
    Returns AxiosPromise<any>
- stopEncodingProcess:function
  - stopEncodingProcess(deviceId: string, playSessionId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/hls-segment-api.ts:377
    summary
    Stops an active encoding.
    
    throws
    {RequiredError}
    
    Parameters
    - deviceId: string
      The device id of the client requesting. Used to stop encoding processes when needed.
    - playSessionId: string
      The play session id.
    - Optional options: any
    Returns AxiosPromise<void>

Const HlsSegmentApiFp

HlsSegmentApiFp(configuration?: Configuration): { getHlsAudioSegmentLegacyAac: any; getHlsAudioSegmentLegacyMp3: any; getHlsPlaylistLegacy: any; getHlsVideoSegmentLegacy: any; stopEncodingProcess: any }

- Defined in generated-client/api/hls-segment-api.ts:248
HlsSegmentApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getHlsAudioSegmentLegacyAac: any; getHlsAudioSegmentLegacyMp3: any; getHlsPlaylistLegacy: any; getHlsVideoSegmentLegacy: any; stopEncodingProcess: any }
- getHlsAudioSegmentLegacyAac:function
  - getHlsAudioSegmentLegacyAac(itemId: string, segmentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/hls-segment-api.ts:259
    summary
    Gets the specified audio segment for an audio item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - segmentId: string
      The segment id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getHlsAudioSegmentLegacyMp3:function
  - getHlsAudioSegmentLegacyMp3(itemId: string, segmentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/hls-segment-api.ts:271
    summary
    Gets the specified audio segment for an audio item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - segmentId: string
      The segment id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getHlsPlaylistLegacy:function
  - getHlsPlaylistLegacy(itemId: string, playlistId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/hls-segment-api.ts:283
    summary
    Gets a hls video playlist.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The video id.
    - playlistId: string
      The playlist id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getHlsVideoSegmentLegacy:function
  - getHlsVideoSegmentLegacy(itemId: string, playlistId: string, segmentId: string, segmentContainer: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/hls-segment-api.ts:297
    summary
    Gets a hls video segment.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - playlistId: string
      The playlist id.
    - segmentId: string
      The segment id.
    - segmentContainer: string
      The segment container.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- stopEncodingProcess:function
  - stopEncodingProcess(deviceId: string, playSessionId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/hls-segment-api.ts:309
    summary
    Stops an active encoding.
    
    throws
    {RequiredError}
    
    Parameters
    - deviceId: string
      The device id of the client requesting. Used to stop encoding processes when needed.
    - playSessionId: string
      The play session id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const ImageApiAxiosParamCreator

ImageApiAxiosParamCreator(configuration?: Configuration): { deleteItemImage: (itemId: string, imageType: ImageType, imageIndex?: number, options?: any) => Promise<RequestArgs>; deleteItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, options?: any) => Promise<RequestArgs>; deleteUserImage: (userId: string, imageType: ImageType, index?: number, options?: any) => Promise<RequestArgs>; deleteUserImageByIndex: (userId: string, imageType: ImageType, index: number, options?: any) => Promise<RequestArgs>; getArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getItemImageInfos: (itemId: string, options?: any) => Promise<RequestArgs>; getMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getUserImage: (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getUserImageByIndex: (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headUserImage: (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headUserImageByIndex: (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; postUserImage: (userId: string, imageType: ImageType, index?: number, body?: any, options?: any) => Promise<RequestArgs>; postUserImageByIndex: (userId: string, imageType: ImageType, index: number, body?: any, options?: any) => Promise<RequestArgs>; setItemImage: (itemId: string, imageType: ImageType, body?: any, options?: any) => Promise<RequestArgs>; setItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, body?: any, options?: any) => Promise<RequestArgs>; updateItemImageIndex: (itemId: string, imageType: ImageType, imageIndex: number, newIndex: number, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/image-api.ts:35
ImageApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { deleteItemImage: (itemId: string, imageType: ImageType, imageIndex?: number, options?: any) => Promise<RequestArgs>; deleteItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, options?: any) => Promise<RequestArgs>; deleteUserImage: (userId: string, imageType: ImageType, index?: number, options?: any) => Promise<RequestArgs>; deleteUserImageByIndex: (userId: string, imageType: ImageType, index: number, options?: any) => Promise<RequestArgs>; getArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getItemImageInfos: (itemId: string, options?: any) => Promise<RequestArgs>; getMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; getUserImage: (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; getUserImageByIndex: (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; headUserImage: (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>; headUserImageByIndex: (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>; postUserImage: (userId: string, imageType: ImageType, index?: number, body?: any, options?: any) => Promise<RequestArgs>; postUserImageByIndex: (userId: string, imageType: ImageType, index: number, body?: any, options?: any) => Promise<RequestArgs>; setItemImage: (itemId: string, imageType: ImageType, body?: any, options?: any) => Promise<RequestArgs>; setItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, body?: any, options?: any) => Promise<RequestArgs>; updateItemImageIndex: (itemId: string, imageType: ImageType, imageIndex: number, newIndex: number, options?: any) => Promise<RequestArgs> }
- deleteItemImage: (itemId: string, imageType: ImageType, imageIndex?: number, options?: any) => Promise<RequestArgs>
  - - (itemId: string, imageType: ImageType, imageIndex?: number, options?: any): Promise<RequestArgs>
    - summary
      Delete an item's image.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item id.
      - imageType: ImageType
        Image type.
      - Optional imageIndex: number
      - options: any = {}
      Returns Promise<RequestArgs>
- deleteItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, options?: any) => Promise<RequestArgs>
  - - (itemId: string, imageType: ImageType, imageIndex: number, options?: any): Promise<RequestArgs>
    - summary
      Delete an item's image.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item id.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        The image index.
      - options: any = {}
      Returns Promise<RequestArgs>
- deleteUserImage: (userId: string, imageType: ImageType, index?: number, options?: any) => Promise<RequestArgs>
  - - (userId: string, imageType: ImageType, index?: number, options?: any): Promise<RequestArgs>
    - summary
      Delete the user's image.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User Id.
      - imageType: ImageType
        (Unused) Image type.
      - Optional index: number
      - options: any = {}
      Returns Promise<RequestArgs>
- deleteUserImageByIndex: (userId: string, imageType: ImageType, index: number, options?: any) => Promise<RequestArgs>
  - - (userId: string, imageType: ImageType, index: number, options?: any): Promise<RequestArgs>
    - summary
      Delete the user's image.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User Id.
      - imageType: ImageType
        (Unused) Image type.
      - index: number
        (Unused) Image index.
      - options: any = {}
      Returns Promise<RequestArgs>
- getArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
    - summary
      Get artist image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Artist name.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        Image index.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
    - summary
      Get genre image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Genre name.
      - imageType: ImageType
        Image type.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - Optional imageIndex: number
      - options: any = {}
      Returns Promise<RequestArgs>
- getGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
    - summary
      Get genre image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Genre name.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        Image index.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
  - - (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
    - summary
      Gets the item's image.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item id.
      - imageType: ImageType
        Image type.
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional tag: string
      - Optional cropWhitespace: boolean
      - Optional format: ImageFormat
      - Optional addPlayedIndicator: boolean
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - Optional imageIndex: number
      - options: any = {}
      Returns Promise<RequestArgs>
- getItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets the item's image.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item id.
      - imageType: ImageType
        Image type.
      - maxWidth: number
        The maximum image width to return.
      - maxHeight: number
        The maximum image height to return.
      - tag: string
        Optional. Supply the cache tag from the item object to receive strong caching headers.
      - format: ImageFormat
        Determines the output format of the image - original,gif,jpg,png.
      - percentPlayed: number
        Optional. Percent to render for the percent played overlay.
      - unplayedCount: number
        Optional. Unplayed count overlay to render.
      - imageIndex: number
        Image index.
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets the item's image.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item id.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        Image index.
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional tag: string
      - Optional cropWhitespace: boolean
      - Optional format: ImageFormat
      - Optional addPlayedIndicator: boolean
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getItemImageInfos: (itemId: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Get item image infos.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
    - summary
      Get music genre image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Music genre name.
      - imageType: ImageType
        Image type.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - Optional imageIndex: number
      - options: any = {}
      Returns Promise<RequestArgs>
- getMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
    - summary
      Get music genre image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Music genre name.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        Image index.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
    - summary
      Get person image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Person name.
      - imageType: ImageType
        Image type.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - Optional imageIndex: number
      - options: any = {}
      Returns Promise<RequestArgs>
- getPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
    - summary
      Get person image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Person name.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        Image index.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
    - summary
      Get studio image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Studio name.
      - imageType: ImageType
        Image type.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - Optional imageIndex: number
      - options: any = {}
      Returns Promise<RequestArgs>
- getStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
    - summary
      Get studio image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Studio name.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        Image index.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getUserImage: (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
  - - (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
    - summary
      Get user profile image.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - imageType: ImageType
        Image type.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - Optional imageIndex: number
      - options: any = {}
      Returns Promise<RequestArgs>
- getUserImageByIndex: (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
    - summary
      Get user profile image.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        Image index.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - options: any = {}
      Returns Promise<RequestArgs>
- headArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
    - summary
      Get artist image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Artist name.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        Image index.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - options: any = {}
      Returns Promise<RequestArgs>
- headGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
    - summary
      Get genre image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Genre name.
      - imageType: ImageType
        Image type.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - Optional imageIndex: number
      - options: any = {}
      Returns Promise<RequestArgs>
- headGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
    - summary
      Get genre image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Genre name.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        Image index.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - options: any = {}
      Returns Promise<RequestArgs>
- headItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
  - - (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
    - summary
      Gets the item's image.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item id.
      - imageType: ImageType
        Image type.
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional tag: string
      - Optional cropWhitespace: boolean
      - Optional format: ImageFormat
      - Optional addPlayedIndicator: boolean
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - Optional imageIndex: number
      - options: any = {}
      Returns Promise<RequestArgs>
- headItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets the item's image.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item id.
      - imageType: ImageType
        Image type.
      - maxWidth: number
        The maximum image width to return.
      - maxHeight: number
        The maximum image height to return.
      - tag: string
        Optional. Supply the cache tag from the item object to receive strong caching headers.
      - format: ImageFormat
        Determines the output format of the image - original,gif,jpg,png.
      - percentPlayed: number
        Optional. Percent to render for the percent played overlay.
      - unplayedCount: number
        Optional. Unplayed count overlay to render.
      - imageIndex: number
        Image index.
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - options: any = {}
      Returns Promise<RequestArgs>
- headItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets the item's image.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item id.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        Image index.
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional tag: string
      - Optional cropWhitespace: boolean
      - Optional format: ImageFormat
      - Optional addPlayedIndicator: boolean
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - options: any = {}
      Returns Promise<RequestArgs>
- headMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
    - summary
      Get music genre image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Music genre name.
      - imageType: ImageType
        Image type.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - Optional imageIndex: number
      - options: any = {}
      Returns Promise<RequestArgs>
- headMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
    - summary
      Get music genre image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Music genre name.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        Image index.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - options: any = {}
      Returns Promise<RequestArgs>
- headPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
    - summary
      Get person image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Person name.
      - imageType: ImageType
        Image type.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - Optional imageIndex: number
      - options: any = {}
      Returns Promise<RequestArgs>
- headPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
    - summary
      Get person image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Person name.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        Image index.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - options: any = {}
      Returns Promise<RequestArgs>
- headStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
    - summary
      Get studio image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Studio name.
      - imageType: ImageType
        Image type.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - Optional imageIndex: number
      - options: any = {}
      Returns Promise<RequestArgs>
- headStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
  - - (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
    - summary
      Get studio image by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Studio name.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        Image index.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - options: any = {}
      Returns Promise<RequestArgs>
- headUserImage: (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any) => Promise<RequestArgs>
  - - (userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<RequestArgs>
    - summary
      Get user profile image.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - imageType: ImageType
        Image type.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - Optional imageIndex: number
      - options: any = {}
      Returns Promise<RequestArgs>
- headUserImageByIndex: (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<RequestArgs>
    - summary
      Get user profile image.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        Image index.
      - Optional tag: string
      - Optional format: ImageFormat
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional percentPlayed: number
      - Optional unplayedCount: number
      - Optional width: number
      - Optional height: number
      - Optional quality: number
      - Optional fillWidth: number
      - Optional fillHeight: number
      - Optional cropWhitespace: boolean
      - Optional addPlayedIndicator: boolean
      - Optional blur: number
      - Optional backgroundColor: string
      - Optional foregroundLayer: string
      - options: any = {}
      Returns Promise<RequestArgs>
- postUserImage: (userId: string, imageType: ImageType, index?: number, body?: any, options?: any) => Promise<RequestArgs>
  - - (userId: string, imageType: ImageType, index?: number, body?: any, options?: any): Promise<RequestArgs>
    - summary
      Sets the user image.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User Id.
      - imageType: ImageType
        (Unused) Image type.
      - Optional index: number
      - Optional body: any
      - options: any = {}
      Returns Promise<RequestArgs>
- postUserImageByIndex: (userId: string, imageType: ImageType, index: number, body?: any, options?: any) => Promise<RequestArgs>
  - - (userId: string, imageType: ImageType, index: number, body?: any, options?: any): Promise<RequestArgs>
    - summary
      Sets the user image.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User Id.
      - imageType: ImageType
        (Unused) Image type.
      - index: number
        (Unused) Image index.
      - Optional body: any
      - options: any = {}
      Returns Promise<RequestArgs>
- setItemImage: (itemId: string, imageType: ImageType, body?: any, options?: any) => Promise<RequestArgs>
  - - (itemId: string, imageType: ImageType, body?: any, options?: any): Promise<RequestArgs>
    - summary
      Set item image.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item id.
      - imageType: ImageType
        Image type.
      - Optional body: any
      - options: any = {}
      Returns Promise<RequestArgs>
- setItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, body?: any, options?: any) => Promise<RequestArgs>
  - - (itemId: string, imageType: ImageType, imageIndex: number, body?: any, options?: any): Promise<RequestArgs>
    - summary
      Set item image.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item id.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        (Unused) Image index.
      - Optional body: any
      - options: any = {}
      Returns Promise<RequestArgs>
- updateItemImageIndex: (itemId: string, imageType: ImageType, imageIndex: number, newIndex: number, options?: any) => Promise<RequestArgs>
  - - (itemId: string, imageType: ImageType, imageIndex: number, newIndex: number, options?: any): Promise<RequestArgs>
    - summary
      Updates the index for an item image.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item id.
      - imageType: ImageType
        Image type.
      - imageIndex: number
        Old image index.
      - newIndex: number
        New image index.
      - options: any = {}
      Returns Promise<RequestArgs>

Const ImageApiFactory

ImageApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { deleteItemImage: any; deleteItemImageByIndex: any; deleteUserImage: any; deleteUserImageByIndex: any; getArtistImage: any; getGenreImage: any; getGenreImageByIndex: any; getItemImage: any; getItemImage2: any; getItemImageByIndex: any; getItemImageInfos: any; getMusicGenreImage: any; getMusicGenreImageByIndex: any; getPersonImage: any; getPersonImageByIndex: any; getStudioImage: any; getStudioImageByIndex: any; getUserImage: any; getUserImageByIndex: any; headArtistImage: any; headGenreImage: any; headGenreImageByIndex: any; headItemImage: any; headItemImage2: any; headItemImageByIndex: any; headMusicGenreImage: any; headMusicGenreImageByIndex: any; headPersonImage: any; headPersonImageByIndex: any; headStudioImage: any; headStudioImageByIndex: any; headUserImage: any; headUserImageByIndex: any; postUserImage: any; postUserImageByIndex: any; setItemImage: any; setItemImageByIndex: any; updateItemImageIndex: any }

- Defined in generated-client/api/image-api.ts:4878
ImageApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { deleteItemImage: any; deleteItemImageByIndex: any; deleteUserImage: any; deleteUserImageByIndex: any; getArtistImage: any; getGenreImage: any; getGenreImageByIndex: any; getItemImage: any; getItemImage2: any; getItemImageByIndex: any; getItemImageInfos: any; getMusicGenreImage: any; getMusicGenreImageByIndex: any; getPersonImage: any; getPersonImageByIndex: any; getStudioImage: any; getStudioImageByIndex: any; getUserImage: any; getUserImageByIndex: any; headArtistImage: any; headGenreImage: any; headGenreImageByIndex: any; headItemImage: any; headItemImage2: any; headItemImageByIndex: any; headMusicGenreImage: any; headMusicGenreImageByIndex: any; headPersonImage: any; headPersonImageByIndex: any; headStudioImage: any; headStudioImageByIndex: any; headUserImage: any; headUserImageByIndex: any; postUserImage: any; postUserImageByIndex: any; setItemImage: any; setItemImageByIndex: any; updateItemImageIndex: any }
- deleteItemImage:function
  - deleteItemImage(itemId: string, imageType: ImageType, imageIndex?: number, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/image-api.ts:4890
    summary
    Delete an item's image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - Optional imageIndex: number
    - Optional options: any
    Returns AxiosPromise<void>
- deleteItemImageByIndex:function
  - deleteItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/image-api.ts:4902
    summary
    Delete an item's image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      The image index.
    - Optional options: any
    Returns AxiosPromise<void>
- deleteUserImage:function
  - deleteUserImage(userId: string, imageType: ImageType, index?: number, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/image-api.ts:4914
    summary
    Delete the user's image.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User Id.
    - imageType: ImageType
      (Unused) Image type.
    - Optional index: number
    - Optional options: any
    Returns AxiosPromise<void>
- deleteUserImageByIndex:function
  - deleteUserImageByIndex(userId: string, imageType: ImageType, index: number, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/image-api.ts:4926
    summary
    Delete the user's image.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User Id.
    - imageType: ImageType
      (Unused) Image type.
    - index: number
      (Unused) Image index.
    - Optional options: any
    Returns AxiosPromise<void>
- getArtistImage:function
  - getArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:4954
    summary
    Get artist image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Artist name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns AxiosPromise<any>
- getGenreImage:function
  - getGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:4982
    summary
    Get genre image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Genre name.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns AxiosPromise<any>
- getGenreImageByIndex:function
  - getGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5010
    summary
    Get genre image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Genre name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns AxiosPromise<any>
- getItemImage:function
  - getItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5038
    summary
    Gets the item's image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional tag: string
    - Optional cropWhitespace: boolean
    - Optional format: ImageFormat
    - Optional addPlayedIndicator: boolean
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns AxiosPromise<any>
- getItemImage2:function
  - getItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5066
    summary
    Gets the item's image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - maxWidth: number
      The maximum image width to return.
    - maxHeight: number
      The maximum image height to return.
    - tag: string
      Optional. Supply the cache tag from the item object to receive strong caching headers.
    - format: ImageFormat
      Determines the output format of the image - original,gif,jpg,png.
    - percentPlayed: number
      Optional. Percent to render for the percent played overlay.
    - unplayedCount: number
      Optional. Unplayed count overlay to render.
    - imageIndex: number
      Image index.
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns AxiosPromise<any>
- getItemImageByIndex:function
  - getItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5094
    summary
    Gets the item's image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional tag: string
    - Optional cropWhitespace: boolean
    - Optional format: ImageFormat
    - Optional addPlayedIndicator: boolean
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns AxiosPromise<any>
- getItemImageInfos:function
  - getItemImageInfos(itemId: string, options?: any): AxiosPromise<ImageInfo[]>
  - - Defined in generated-client/api/image-api.ts:5104
    summary
    Get item image infos.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - Optional options: any
    Returns AxiosPromise<ImageInfo[]>
- getMusicGenreImage:function
  - getMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5132
    summary
    Get music genre image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Music genre name.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns AxiosPromise<any>
- getMusicGenreImageByIndex:function
  - getMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5160
    summary
    Get music genre image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Music genre name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns AxiosPromise<any>
- getPersonImage:function
  - getPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5188
    summary
    Get person image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Person name.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns AxiosPromise<any>
- getPersonImageByIndex:function
  - getPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5216
    summary
    Get person image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Person name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns AxiosPromise<any>
- getStudioImage:function
  - getStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5244
    summary
    Get studio image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Studio name.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns AxiosPromise<any>
- getStudioImageByIndex:function
  - getStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5272
    summary
    Get studio image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Studio name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns AxiosPromise<any>
- getUserImage:function
  - getUserImage(userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5300
    summary
    Get user profile image.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns AxiosPromise<any>
- getUserImageByIndex:function
  - getUserImageByIndex(userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5328
    summary
    Get user profile image.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns AxiosPromise<any>
- headArtistImage:function
  - headArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5356
    summary
    Get artist image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Artist name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns AxiosPromise<any>
- headGenreImage:function
  - headGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5384
    summary
    Get genre image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Genre name.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns AxiosPromise<any>
- headGenreImageByIndex:function
  - headGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5412
    summary
    Get genre image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Genre name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns AxiosPromise<any>
- headItemImage:function
  - headItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5440
    summary
    Gets the item's image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional tag: string
    - Optional cropWhitespace: boolean
    - Optional format: ImageFormat
    - Optional addPlayedIndicator: boolean
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns AxiosPromise<any>
- headItemImage2:function
  - headItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5468
    summary
    Gets the item's image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - maxWidth: number
      The maximum image width to return.
    - maxHeight: number
      The maximum image height to return.
    - tag: string
      Optional. Supply the cache tag from the item object to receive strong caching headers.
    - format: ImageFormat
      Determines the output format of the image - original,gif,jpg,png.
    - percentPlayed: number
      Optional. Percent to render for the percent played overlay.
    - unplayedCount: number
      Optional. Unplayed count overlay to render.
    - imageIndex: number
      Image index.
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns AxiosPromise<any>
- headItemImageByIndex:function
  - headItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5496
    summary
    Gets the item's image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional tag: string
    - Optional cropWhitespace: boolean
    - Optional format: ImageFormat
    - Optional addPlayedIndicator: boolean
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns AxiosPromise<any>
- headMusicGenreImage:function
  - headMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5524
    summary
    Get music genre image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Music genre name.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns AxiosPromise<any>
- headMusicGenreImageByIndex:function
  - headMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5552
    summary
    Get music genre image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Music genre name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns AxiosPromise<any>
- headPersonImage:function
  - headPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5580
    summary
    Get person image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Person name.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns AxiosPromise<any>
- headPersonImageByIndex:function
  - headPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5608
    summary
    Get person image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Person name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns AxiosPromise<any>
- headStudioImage:function
  - headStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5636
    summary
    Get studio image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Studio name.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns AxiosPromise<any>
- headStudioImageByIndex:function
  - headStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5664
    summary
    Get studio image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Studio name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns AxiosPromise<any>
- headUserImage:function
  - headUserImage(userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5692
    summary
    Get user profile image.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns AxiosPromise<any>
- headUserImageByIndex:function
  - headUserImageByIndex(userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-api.ts:5720
    summary
    Get user profile image.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns AxiosPromise<any>
- postUserImage:function
  - postUserImage(userId: string, imageType: ImageType, index?: number, body?: any, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/image-api.ts:5733
    summary
    Sets the user image.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User Id.
    - imageType: ImageType
      (Unused) Image type.
    - Optional index: number
    - Optional body: any
    - Optional options: any
    Returns AxiosPromise<void>
- postUserImageByIndex:function
  - postUserImageByIndex(userId: string, imageType: ImageType, index: number, body?: any, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/image-api.ts:5746
    summary
    Sets the user image.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User Id.
    - imageType: ImageType
      (Unused) Image type.
    - index: number
      (Unused) Image index.
    - Optional body: any
    - Optional options: any
    Returns AxiosPromise<void>
- setItemImage:function
  - setItemImage(itemId: string, imageType: ImageType, body?: any, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/image-api.ts:5758
    summary
    Set item image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - Optional body: any
    - Optional options: any
    Returns AxiosPromise<void>
- setItemImageByIndex:function
  - setItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, body?: any, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/image-api.ts:5771
    summary
    Set item image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      (Unused) Image index.
    - Optional body: any
    - Optional options: any
    Returns AxiosPromise<void>
- updateItemImageIndex:function
  - updateItemImageIndex(itemId: string, imageType: ImageType, imageIndex: number, newIndex: number, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/image-api.ts:5784
    summary
    Updates the index for an item image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Old image index.
    - newIndex: number
      New image index.
    - Optional options: any
    Returns AxiosPromise<void>

Const ImageApiFp

ImageApiFp(configuration?: Configuration): { deleteItemImage: any; deleteItemImageByIndex: any; deleteUserImage: any; deleteUserImageByIndex: any; getArtistImage: any; getGenreImage: any; getGenreImageByIndex: any; getItemImage: any; getItemImage2: any; getItemImageByIndex: any; getItemImageInfos: any; getMusicGenreImage: any; getMusicGenreImageByIndex: any; getPersonImage: any; getPersonImageByIndex: any; getStudioImage: any; getStudioImageByIndex: any; getUserImage: any; getUserImageByIndex: any; headArtistImage: any; headGenreImage: any; headGenreImageByIndex: any; headItemImage: any; headItemImage2: any; headItemImageByIndex: any; headMusicGenreImage: any; headMusicGenreImageByIndex: any; headPersonImage: any; headPersonImageByIndex: any; headStudioImage: any; headStudioImageByIndex: any; headUserImage: any; headUserImageByIndex: any; postUserImage: any; postUserImageByIndex: any; setItemImage: any; setItemImageByIndex: any; updateItemImageIndex: any }

- Defined in generated-client/api/image-api.ts:3924
ImageApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { deleteItemImage: any; deleteItemImageByIndex: any; deleteUserImage: any; deleteUserImageByIndex: any; getArtistImage: any; getGenreImage: any; getGenreImageByIndex: any; getItemImage: any; getItemImage2: any; getItemImageByIndex: any; getItemImageInfos: any; getMusicGenreImage: any; getMusicGenreImageByIndex: any; getPersonImage: any; getPersonImageByIndex: any; getStudioImage: any; getStudioImageByIndex: any; getUserImage: any; getUserImageByIndex: any; headArtistImage: any; headGenreImage: any; headGenreImageByIndex: any; headItemImage: any; headItemImage2: any; headItemImageByIndex: any; headMusicGenreImage: any; headMusicGenreImageByIndex: any; headPersonImage: any; headPersonImageByIndex: any; headStudioImage: any; headStudioImageByIndex: any; headUserImage: any; headUserImageByIndex: any; postUserImage: any; postUserImageByIndex: any; setItemImage: any; setItemImageByIndex: any; updateItemImageIndex: any }
- deleteItemImage:function
  - deleteItemImage(itemId: string, imageType: ImageType, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/image-api.ts:3936
    summary
    Delete an item's image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - Optional imageIndex: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- deleteItemImageByIndex:function
  - deleteItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/image-api.ts:3949
    summary
    Delete an item's image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      The image index.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- deleteUserImage:function
  - deleteUserImage(userId: string, imageType: ImageType, index?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/image-api.ts:3962
    summary
    Delete the user's image.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User Id.
    - imageType: ImageType
      (Unused) Image type.
    - Optional index: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- deleteUserImageByIndex:function
  - deleteUserImageByIndex(userId: string, imageType: ImageType, index: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/image-api.ts:3975
    summary
    Delete the user's image.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User Id.
    - imageType: ImageType
      (Unused) Image type.
    - index: number
      (Unused) Image index.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getArtistImage:function
  - getArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4004
    summary
    Get artist image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Artist name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getGenreImage:function
  - getGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4033
    summary
    Get genre image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Genre name.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getGenreImageByIndex:function
  - getGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4062
    summary
    Get genre image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Genre name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getItemImage:function
  - getItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4091
    summary
    Gets the item's image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional tag: string
    - Optional cropWhitespace: boolean
    - Optional format: ImageFormat
    - Optional addPlayedIndicator: boolean
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getItemImage2:function
  - getItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4120
    summary
    Gets the item's image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - maxWidth: number
      The maximum image width to return.
    - maxHeight: number
      The maximum image height to return.
    - tag: string
      Optional. Supply the cache tag from the item object to receive strong caching headers.
    - format: ImageFormat
      Determines the output format of the image - original,gif,jpg,png.
    - percentPlayed: number
      Optional. Percent to render for the percent played overlay.
    - unplayedCount: number
      Optional. Unplayed count overlay to render.
    - imageIndex: number
      Image index.
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getItemImageByIndex:function
  - getItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4149
    summary
    Gets the item's image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional tag: string
    - Optional cropWhitespace: boolean
    - Optional format: ImageFormat
    - Optional addPlayedIndicator: boolean
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getItemImageInfos:function
  - getItemImageInfos(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageInfo[]>>
  - - Defined in generated-client/api/image-api.ts:4160
    summary
    Get item image infos.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageInfo[]>>
- getMusicGenreImage:function
  - getMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4189
    summary
    Get music genre image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Music genre name.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getMusicGenreImageByIndex:function
  - getMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4218
    summary
    Get music genre image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Music genre name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getPersonImage:function
  - getPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4247
    summary
    Get person image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Person name.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getPersonImageByIndex:function
  - getPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4276
    summary
    Get person image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Person name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getStudioImage:function
  - getStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4305
    summary
    Get studio image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Studio name.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getStudioImageByIndex:function
  - getStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4334
    summary
    Get studio image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Studio name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getUserImage:function
  - getUserImage(userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4363
    summary
    Get user profile image.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getUserImageByIndex:function
  - getUserImageByIndex(userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4392
    summary
    Get user profile image.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headArtistImage:function
  - headArtistImage(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4421
    summary
    Get artist image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Artist name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headGenreImage:function
  - headGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4450
    summary
    Get genre image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Genre name.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headGenreImageByIndex:function
  - headGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4479
    summary
    Get genre image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Genre name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headItemImage:function
  - headItemImage(itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4508
    summary
    Gets the item's image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional tag: string
    - Optional cropWhitespace: boolean
    - Optional format: ImageFormat
    - Optional addPlayedIndicator: boolean
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headItemImage2:function
  - headItemImage2(itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4537
    summary
    Gets the item's image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - maxWidth: number
      The maximum image width to return.
    - maxHeight: number
      The maximum image height to return.
    - tag: string
      Optional. Supply the cache tag from the item object to receive strong caching headers.
    - format: ImageFormat
      Determines the output format of the image - original,gif,jpg,png.
    - percentPlayed: number
      Optional. Percent to render for the percent played overlay.
    - unplayedCount: number
      Optional. Unplayed count overlay to render.
    - imageIndex: number
      Image index.
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headItemImageByIndex:function
  - headItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, cropWhitespace?: boolean, format?: ImageFormat, addPlayedIndicator?: boolean, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4566
    summary
    Gets the item's image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional tag: string
    - Optional cropWhitespace: boolean
    - Optional format: ImageFormat
    - Optional addPlayedIndicator: boolean
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headMusicGenreImage:function
  - headMusicGenreImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4595
    summary
    Get music genre image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Music genre name.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headMusicGenreImageByIndex:function
  - headMusicGenreImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4624
    summary
    Get music genre image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Music genre name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headPersonImage:function
  - headPersonImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4653
    summary
    Get person image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Person name.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headPersonImageByIndex:function
  - headPersonImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4682
    summary
    Get person image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Person name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headStudioImage:function
  - headStudioImage(name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4711
    summary
    Get studio image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Studio name.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headStudioImageByIndex:function
  - headStudioImageByIndex(name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4740
    summary
    Get studio image by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Studio name.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headUserImage:function
  - headUserImage(userId: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4769
    summary
    Get user profile image.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - imageType: ImageType
      Image type.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional imageIndex: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headUserImageByIndex:function
  - headUserImageByIndex(userId: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, cropWhitespace?: boolean, addPlayedIndicator?: boolean, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-api.ts:4798
    summary
    Get user profile image.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Image index.
    - Optional tag: string
    - Optional format: ImageFormat
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional percentPlayed: number
    - Optional unplayedCount: number
    - Optional width: number
    - Optional height: number
    - Optional quality: number
    - Optional fillWidth: number
    - Optional fillHeight: number
    - Optional cropWhitespace: boolean
    - Optional addPlayedIndicator: boolean
    - Optional blur: number
    - Optional backgroundColor: string
    - Optional foregroundLayer: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- postUserImage:function
  - postUserImage(userId: string, imageType: ImageType, index?: number, body?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/image-api.ts:4812
    summary
    Sets the user image.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User Id.
    - imageType: ImageType
      (Unused) Image type.
    - Optional index: number
    - Optional body: any
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- postUserImageByIndex:function
  - postUserImageByIndex(userId: string, imageType: ImageType, index: number, body?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/image-api.ts:4826
    summary
    Sets the user image.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User Id.
    - imageType: ImageType
      (Unused) Image type.
    - index: number
      (Unused) Image index.
    - Optional body: any
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- setItemImage:function
  - setItemImage(itemId: string, imageType: ImageType, body?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/image-api.ts:4839
    summary
    Set item image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - Optional body: any
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- setItemImageByIndex:function
  - setItemImageByIndex(itemId: string, imageType: ImageType, imageIndex: number, body?: any, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/image-api.ts:4853
    summary
    Set item image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      (Unused) Image index.
    - Optional body: any
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- updateItemImageIndex:function
  - updateItemImageIndex(itemId: string, imageType: ImageType, imageIndex: number, newIndex: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/image-api.ts:4867
    summary
    Updates the index for an item image.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - imageType: ImageType
      Image type.
    - imageIndex: number
      Old image index.
    - newIndex: number
      New image index.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const ImageByNameApiAxiosParamCreator

ImageByNameApiAxiosParamCreator(configuration?: Configuration): { getGeneralImage: (name: string, type: string, options?: any) => Promise<RequestArgs>; getGeneralImages: (options?: any) => Promise<RequestArgs>; getMediaInfoImage: (theme: string, name: string, options?: any) => Promise<RequestArgs>; getMediaInfoImages: (options?: any) => Promise<RequestArgs>; getRatingImage: (theme: string, name: string, options?: any) => Promise<RequestArgs>; getRatingImages: (options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/image-by-name-api.ts:31
ImageByNameApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getGeneralImage: (name: string, type: string, options?: any) => Promise<RequestArgs>; getGeneralImages: (options?: any) => Promise<RequestArgs>; getMediaInfoImage: (theme: string, name: string, options?: any) => Promise<RequestArgs>; getMediaInfoImages: (options?: any) => Promise<RequestArgs>; getRatingImage: (theme: string, name: string, options?: any) => Promise<RequestArgs>; getRatingImages: (options?: any) => Promise<RequestArgs> }
- getGeneralImage: (name: string, type: string, options?: any) => Promise<RequestArgs>
  - - (name: string, type: string, options?: any): Promise<RequestArgs>
    - summary
      Get General Image.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        The name of the image.
      - type: string
        Image Type (primary, backdrop, logo, etc).
      - options: any = {}
      Returns Promise<RequestArgs>
- getGeneralImages: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Get all general images.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getMediaInfoImage: (theme: string, name: string, options?: any) => Promise<RequestArgs>
  - - (theme: string, name: string, options?: any): Promise<RequestArgs>
    - summary
      Get media info image.
      
      throws
      {RequiredError}
      
      Parameters
      - theme: string
        The theme to get the image from.
      - name: string
        The name of the image.
      - options: any = {}
      Returns Promise<RequestArgs>
- getMediaInfoImages: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Get all media info images.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getRatingImage: (theme: string, name: string, options?: any) => Promise<RequestArgs>
  - - (theme: string, name: string, options?: any): Promise<RequestArgs>
    - summary
      Get rating image.
      
      throws
      {RequiredError}
      
      Parameters
      - theme: string
        The theme to get the image from.
      - name: string
        The name of the image.
      - options: any = {}
      Returns Promise<RequestArgs>
- getRatingImages: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Get all general images.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>

Const ImageByNameApiFactory

ImageByNameApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getGeneralImage: any; getGeneralImages: any; getMediaInfoImage: any; getMediaInfoImages: any; getRatingImage: any; getRatingImages: any }

- Defined in generated-client/api/image-by-name-api.ts:329
ImageByNameApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getGeneralImage: any; getGeneralImages: any; getMediaInfoImage: any; getMediaInfoImages: any; getRatingImage: any; getRatingImages: any }
- getGeneralImage:function
  - getGeneralImage(name: string, type: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-by-name-api.ts:340
    summary
    Get General Image.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      The name of the image.
    - type: string
      Image Type (primary, backdrop, logo, etc).
    - Optional options: any
    Returns AxiosPromise<any>
- getGeneralImages:function
  - getGeneralImages(options?: any): AxiosPromise<ImageByNameInfo[]>
  - - Defined in generated-client/api/image-by-name-api.ts:349
    summary
    Get all general images.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<ImageByNameInfo[]>
- getMediaInfoImage:function
  - getMediaInfoImage(theme: string, name: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-by-name-api.ts:360
    summary
    Get media info image.
    
    throws
    {RequiredError}
    
    Parameters
    - theme: string
      The theme to get the image from.
    - name: string
      The name of the image.
    - Optional options: any
    Returns AxiosPromise<any>
- getMediaInfoImages:function
  - getMediaInfoImages(options?: any): AxiosPromise<ImageByNameInfo[]>
  - - Defined in generated-client/api/image-by-name-api.ts:369
    summary
    Get all media info images.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<ImageByNameInfo[]>
- getRatingImage:function
  - getRatingImage(theme: string, name: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/image-by-name-api.ts:380
    summary
    Get rating image.
    
    throws
    {RequiredError}
    
    Parameters
    - theme: string
      The theme to get the image from.
    - name: string
      The name of the image.
    - Optional options: any
    Returns AxiosPromise<any>
- getRatingImages:function
  - getRatingImages(options?: any): AxiosPromise<ImageByNameInfo[]>
  - - Defined in generated-client/api/image-by-name-api.ts:389
    summary
    Get all general images.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<ImageByNameInfo[]>

Const ImageByNameApiFp

ImageByNameApiFp(configuration?: Configuration): { getGeneralImage: any; getGeneralImages: any; getMediaInfoImage: any; getMediaInfoImages: any; getRatingImage: any; getRatingImages: any }

- Defined in generated-client/api/image-by-name-api.ts:253
ImageByNameApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getGeneralImage: any; getGeneralImages: any; getMediaInfoImage: any; getMediaInfoImages: any; getRatingImage: any; getRatingImages: any }
- getGeneralImage:function
  - getGeneralImage(name: string, type: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-by-name-api.ts:264
    summary
    Get General Image.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      The name of the image.
    - type: string
      Image Type (primary, backdrop, logo, etc).
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getGeneralImages:function
  - getGeneralImages(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageByNameInfo[]>>
  - - Defined in generated-client/api/image-by-name-api.ts:274
    summary
    Get all general images.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageByNameInfo[]>>
- getMediaInfoImage:function
  - getMediaInfoImage(theme: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-by-name-api.ts:286
    summary
    Get media info image.
    
    throws
    {RequiredError}
    
    Parameters
    - theme: string
      The theme to get the image from.
    - name: string
      The name of the image.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getMediaInfoImages:function
  - getMediaInfoImages(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageByNameInfo[]>>
  - - Defined in generated-client/api/image-by-name-api.ts:296
    summary
    Get all media info images.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageByNameInfo[]>>
- getRatingImage:function
  - getRatingImage(theme: string, name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/image-by-name-api.ts:308
    summary
    Get rating image.
    
    throws
    {RequiredError}
    
    Parameters
    - theme: string
      The theme to get the image from.
    - name: string
      The name of the image.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getRatingImages:function
  - getRatingImages(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageByNameInfo[]>>
  - - Defined in generated-client/api/image-by-name-api.ts:318
    summary
    Get all general images.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageByNameInfo[]>>

Const InstantMixApiAxiosParamCreator

InstantMixApiAxiosParamCreator(configuration?: Configuration): { getInstantMixFromAlbum: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromArtists: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromArtists2: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromItem: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromMusicGenreById: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromMusicGenreById2: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromMusicGenreByName: (name: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromPlaylist: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromSong: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/instant-mix-api.ts:33
InstantMixApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getInstantMixFromAlbum: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromArtists: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromArtists2: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromItem: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromMusicGenreById: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromMusicGenreById2: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromMusicGenreByName: (name: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromPlaylist: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; getInstantMixFromSong: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs> }
- getInstantMixFromAlbum: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
  - - (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
    - summary
      Creates an instant playlist based on a given album.
      
      throws
      {RequiredError}
      
      Parameters
      - id: string
        The item id.
      - Optional userId: string
      - Optional limit: number
      - Optional fields: ItemFields[]
      - Optional enableImages: boolean
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - options: any = {}
      Returns Promise<RequestArgs>
- getInstantMixFromArtists: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
  - - (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
    - summary
      Creates an instant playlist based on a given artist.
      
      throws
      {RequiredError}
      
      Parameters
      - id: string
        The item id.
      - Optional userId: string
      - Optional limit: number
      - Optional fields: ItemFields[]
      - Optional enableImages: boolean
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - options: any = {}
      Returns Promise<RequestArgs>
- getInstantMixFromArtists2: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
  - - (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
    - summary
      Creates an instant playlist based on a given artist.
      
      deprecated
      throws
      {RequiredError}
      
      Parameters
      - id: string
        The item id.
      - Optional userId: string
      - Optional limit: number
      - Optional fields: ItemFields[]
      - Optional enableImages: boolean
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - options: any = {}
      Returns Promise<RequestArgs>
- getInstantMixFromItem: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
  - - (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
    - summary
      Creates an instant playlist based on a given item.
      
      throws
      {RequiredError}
      
      Parameters
      - id: string
        The item id.
      - Optional userId: string
      - Optional limit: number
      - Optional fields: ItemFields[]
      - Optional enableImages: boolean
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - options: any = {}
      Returns Promise<RequestArgs>
- getInstantMixFromMusicGenreById: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
  - - (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
    - summary
      Creates an instant playlist based on a given genre.
      
      throws
      {RequiredError}
      
      Parameters
      - id: string
        The item id.
      - Optional userId: string
      - Optional limit: number
      - Optional fields: ItemFields[]
      - Optional enableImages: boolean
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - options: any = {}
      Returns Promise<RequestArgs>
- getInstantMixFromMusicGenreById2: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
  - - (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
    - summary
      Creates an instant playlist based on a given genre.
      
      deprecated
      throws
      {RequiredError}
      
      Parameters
      - id: string
        The item id.
      - Optional userId: string
      - Optional limit: number
      - Optional fields: ItemFields[]
      - Optional enableImages: boolean
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - options: any = {}
      Returns Promise<RequestArgs>
- getInstantMixFromMusicGenreByName: (name: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
  - - (name: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
    - summary
      Creates an instant playlist based on a given genre.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        The genre name.
      - Optional userId: string
      - Optional limit: number
      - Optional fields: ItemFields[]
      - Optional enableImages: boolean
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - options: any = {}
      Returns Promise<RequestArgs>
- getInstantMixFromPlaylist: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
  - - (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
    - summary
      Creates an instant playlist based on a given playlist.
      
      throws
      {RequiredError}
      
      Parameters
      - id: string
        The item id.
      - Optional userId: string
      - Optional limit: number
      - Optional fields: ItemFields[]
      - Optional enableImages: boolean
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - options: any = {}
      Returns Promise<RequestArgs>
- getInstantMixFromSong: (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
  - - (id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
    - summary
      Creates an instant playlist based on a given song.
      
      throws
      {RequiredError}
      
      Parameters
      - id: string
        The item id.
      - Optional userId: string
      - Optional limit: number
      - Optional fields: ItemFields[]
      - Optional enableImages: boolean
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - options: any = {}
      Returns Promise<RequestArgs>

Const InstantMixApiFactory

InstantMixApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getInstantMixFromAlbum: any; getInstantMixFromArtists: any; getInstantMixFromArtists2: any; getInstantMixFromItem: any; getInstantMixFromMusicGenreById: any; getInstantMixFromMusicGenreById2: any; getInstantMixFromMusicGenreByName: any; getInstantMixFromPlaylist: any; getInstantMixFromSong: any }

- Defined in generated-client/api/instant-mix-api.ts:872
InstantMixApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getInstantMixFromAlbum: any; getInstantMixFromArtists: any; getInstantMixFromArtists2: any; getInstantMixFromItem: any; getInstantMixFromMusicGenreById: any; getInstantMixFromMusicGenreById2: any; getInstantMixFromMusicGenreByName: any; getInstantMixFromPlaylist: any; getInstantMixFromSong: any }
- getInstantMixFromAlbum:function
  - getInstantMixFromAlbum(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/instant-mix-api.ts:889
    summary
    Creates an instant playlist based on a given album.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getInstantMixFromArtists:function
  - getInstantMixFromArtists(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/instant-mix-api.ts:906
    summary
    Creates an instant playlist based on a given artist.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getInstantMixFromArtists2:function
  - getInstantMixFromArtists2(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/instant-mix-api.ts:924
    summary
    Creates an instant playlist based on a given artist.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getInstantMixFromItem:function
  - getInstantMixFromItem(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/instant-mix-api.ts:941
    summary
    Creates an instant playlist based on a given item.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getInstantMixFromMusicGenreById:function
  - getInstantMixFromMusicGenreById(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/instant-mix-api.ts:958
    summary
    Creates an instant playlist based on a given genre.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getInstantMixFromMusicGenreById2:function
  - getInstantMixFromMusicGenreById2(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/instant-mix-api.ts:976
    summary
    Creates an instant playlist based on a given genre.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getInstantMixFromMusicGenreByName:function
  - getInstantMixFromMusicGenreByName(name: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/instant-mix-api.ts:993
    summary
    Creates an instant playlist based on a given genre.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      The genre name.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getInstantMixFromPlaylist:function
  - getInstantMixFromPlaylist(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/instant-mix-api.ts:1010
    summary
    Creates an instant playlist based on a given playlist.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getInstantMixFromSong:function
  - getInstantMixFromSong(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/instant-mix-api.ts:1027
    summary
    Creates an instant playlist based on a given song.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>

Const InstantMixApiFp

InstantMixApiFp(configuration?: Configuration): { getInstantMixFromAlbum: any; getInstantMixFromArtists: any; getInstantMixFromArtists2: any; getInstantMixFromItem: any; getInstantMixFromMusicGenreById: any; getInstantMixFromMusicGenreById2: any; getInstantMixFromMusicGenreByName: any; getInstantMixFromPlaylist: any; getInstantMixFromSong: any }

- Defined in generated-client/api/instant-mix-api.ts:698
InstantMixApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getInstantMixFromAlbum: any; getInstantMixFromArtists: any; getInstantMixFromArtists2: any; getInstantMixFromItem: any; getInstantMixFromMusicGenreById: any; getInstantMixFromMusicGenreById2: any; getInstantMixFromMusicGenreByName: any; getInstantMixFromPlaylist: any; getInstantMixFromSong: any }
- getInstantMixFromAlbum:function
  - getInstantMixFromAlbum(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/instant-mix-api.ts:715
    summary
    Creates an instant playlist based on a given album.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getInstantMixFromArtists:function
  - getInstantMixFromArtists(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/instant-mix-api.ts:733
    summary
    Creates an instant playlist based on a given artist.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getInstantMixFromArtists2:function
  - getInstantMixFromArtists2(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/instant-mix-api.ts:752
    summary
    Creates an instant playlist based on a given artist.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getInstantMixFromItem:function
  - getInstantMixFromItem(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/instant-mix-api.ts:770
    summary
    Creates an instant playlist based on a given item.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getInstantMixFromMusicGenreById:function
  - getInstantMixFromMusicGenreById(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/instant-mix-api.ts:788
    summary
    Creates an instant playlist based on a given genre.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getInstantMixFromMusicGenreById2:function
  - getInstantMixFromMusicGenreById2(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/instant-mix-api.ts:807
    summary
    Creates an instant playlist based on a given genre.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getInstantMixFromMusicGenreByName:function
  - getInstantMixFromMusicGenreByName(name: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/instant-mix-api.ts:825
    summary
    Creates an instant playlist based on a given genre.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      The genre name.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getInstantMixFromPlaylist:function
  - getInstantMixFromPlaylist(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/instant-mix-api.ts:843
    summary
    Creates an instant playlist based on a given playlist.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getInstantMixFromSong:function
  - getInstantMixFromSong(id: string, userId?: string, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/instant-mix-api.ts:861
    summary
    Creates an instant playlist based on a given song.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>

Const ItemLookupApiAxiosParamCreator

ItemLookupApiAxiosParamCreator(configuration?: Configuration): { applySearchCriteria: (itemId: string, remoteSearchResult: RemoteSearchResult, replaceAllImages?: boolean, options?: any) => Promise<RequestArgs>; getBookRemoteSearchResults: (bookInfoRemoteSearchQuery: BookInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getBoxSetRemoteSearchResults: (boxSetInfoRemoteSearchQuery: BoxSetInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getExternalIdInfos: (itemId: string, options?: any) => Promise<RequestArgs>; getMovieRemoteSearchResults: (movieInfoRemoteSearchQuery: MovieInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getMusicAlbumRemoteSearchResults: (albumInfoRemoteSearchQuery: AlbumInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getMusicArtistRemoteSearchResults: (artistInfoRemoteSearchQuery: ArtistInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getMusicVideoRemoteSearchResults: (musicVideoInfoRemoteSearchQuery: MusicVideoInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getPersonRemoteSearchResults: (personLookupInfoRemoteSearchQuery: PersonLookupInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getSeriesRemoteSearchResults: (seriesInfoRemoteSearchQuery: SeriesInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getTrailerRemoteSearchResults: (trailerInfoRemoteSearchQuery: TrailerInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/item-lookup-api.ts:51
ItemLookupApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { applySearchCriteria: (itemId: string, remoteSearchResult: RemoteSearchResult, replaceAllImages?: boolean, options?: any) => Promise<RequestArgs>; getBookRemoteSearchResults: (bookInfoRemoteSearchQuery: BookInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getBoxSetRemoteSearchResults: (boxSetInfoRemoteSearchQuery: BoxSetInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getExternalIdInfos: (itemId: string, options?: any) => Promise<RequestArgs>; getMovieRemoteSearchResults: (movieInfoRemoteSearchQuery: MovieInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getMusicAlbumRemoteSearchResults: (albumInfoRemoteSearchQuery: AlbumInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getMusicArtistRemoteSearchResults: (artistInfoRemoteSearchQuery: ArtistInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getMusicVideoRemoteSearchResults: (musicVideoInfoRemoteSearchQuery: MusicVideoInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getPersonRemoteSearchResults: (personLookupInfoRemoteSearchQuery: PersonLookupInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getSeriesRemoteSearchResults: (seriesInfoRemoteSearchQuery: SeriesInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>; getTrailerRemoteSearchResults: (trailerInfoRemoteSearchQuery: TrailerInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs> }
- applySearchCriteria: (itemId: string, remoteSearchResult: RemoteSearchResult, replaceAllImages?: boolean, options?: any) => Promise<RequestArgs>
  - - (itemId: string, remoteSearchResult: RemoteSearchResult, replaceAllImages?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Applies search criteria to an item and refreshes metadata.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item id.
      - remoteSearchResult: RemoteSearchResult
        The remote search result.
      - Optional replaceAllImages: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getBookRemoteSearchResults: (bookInfoRemoteSearchQuery: BookInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
  - - (bookInfoRemoteSearchQuery: BookInfoRemoteSearchQuery, options?: any): Promise<RequestArgs>
    - summary
      Get book remote search.
      
      throws
      {RequiredError}
      
      Parameters
      - bookInfoRemoteSearchQuery: BookInfoRemoteSearchQuery
        Remote search query.
      - options: any = {}
      Returns Promise<RequestArgs>
- getBoxSetRemoteSearchResults: (boxSetInfoRemoteSearchQuery: BoxSetInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
  - - (boxSetInfoRemoteSearchQuery: BoxSetInfoRemoteSearchQuery, options?: any): Promise<RequestArgs>
    - summary
      Get box set remote search.
      
      throws
      {RequiredError}
      
      Parameters
      - boxSetInfoRemoteSearchQuery: BoxSetInfoRemoteSearchQuery
        Remote search query.
      - options: any = {}
      Returns Promise<RequestArgs>
- getExternalIdInfos: (itemId: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Get the item's external id info.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getMovieRemoteSearchResults: (movieInfoRemoteSearchQuery: MovieInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
  - - (movieInfoRemoteSearchQuery: MovieInfoRemoteSearchQuery, options?: any): Promise<RequestArgs>
    - summary
      Get movie remote search.
      
      throws
      {RequiredError}
      
      Parameters
      - movieInfoRemoteSearchQuery: MovieInfoRemoteSearchQuery
        Remote search query.
      - options: any = {}
      Returns Promise<RequestArgs>
- getMusicAlbumRemoteSearchResults: (albumInfoRemoteSearchQuery: AlbumInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
  - - (albumInfoRemoteSearchQuery: AlbumInfoRemoteSearchQuery, options?: any): Promise<RequestArgs>
    - summary
      Get music album remote search.
      
      throws
      {RequiredError}
      
      Parameters
      - albumInfoRemoteSearchQuery: AlbumInfoRemoteSearchQuery
        Remote search query.
      - options: any = {}
      Returns Promise<RequestArgs>
- getMusicArtistRemoteSearchResults: (artistInfoRemoteSearchQuery: ArtistInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
  - - (artistInfoRemoteSearchQuery: ArtistInfoRemoteSearchQuery, options?: any): Promise<RequestArgs>
    - summary
      Get music artist remote search.
      
      throws
      {RequiredError}
      
      Parameters
      - artistInfoRemoteSearchQuery: ArtistInfoRemoteSearchQuery
        Remote search query.
      - options: any = {}
      Returns Promise<RequestArgs>
- getMusicVideoRemoteSearchResults: (musicVideoInfoRemoteSearchQuery: MusicVideoInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
  - - (musicVideoInfoRemoteSearchQuery: MusicVideoInfoRemoteSearchQuery, options?: any): Promise<RequestArgs>
    - summary
      Get music video remote search.
      
      throws
      {RequiredError}
      
      Parameters
      - musicVideoInfoRemoteSearchQuery: MusicVideoInfoRemoteSearchQuery
        Remote search query.
      - options: any = {}
      Returns Promise<RequestArgs>
- getPersonRemoteSearchResults: (personLookupInfoRemoteSearchQuery: PersonLookupInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
  - - (personLookupInfoRemoteSearchQuery: PersonLookupInfoRemoteSearchQuery, options?: any): Promise<RequestArgs>
    - summary
      Get person remote search.
      
      throws
      {RequiredError}
      
      Parameters
      - personLookupInfoRemoteSearchQuery: PersonLookupInfoRemoteSearchQuery
        Remote search query.
      - options: any = {}
      Returns Promise<RequestArgs>
- getSeriesRemoteSearchResults: (seriesInfoRemoteSearchQuery: SeriesInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
  - - (seriesInfoRemoteSearchQuery: SeriesInfoRemoteSearchQuery, options?: any): Promise<RequestArgs>
    - summary
      Get series remote search.
      
      throws
      {RequiredError}
      
      Parameters
      - seriesInfoRemoteSearchQuery: SeriesInfoRemoteSearchQuery
        Remote search query.
      - options: any = {}
      Returns Promise<RequestArgs>
- getTrailerRemoteSearchResults: (trailerInfoRemoteSearchQuery: TrailerInfoRemoteSearchQuery, options?: any) => Promise<RequestArgs>
  - - (trailerInfoRemoteSearchQuery: TrailerInfoRemoteSearchQuery, options?: any): Promise<RequestArgs>
    - summary
      Get trailer remote search.
      
      throws
      {RequiredError}
      
      Parameters
      - trailerInfoRemoteSearchQuery: TrailerInfoRemoteSearchQuery
        Remote search query.
      - options: any = {}
      Returns Promise<RequestArgs>

Const ItemLookupApiFactory

ItemLookupApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { applySearchCriteria: any; getBookRemoteSearchResults: any; getBoxSetRemoteSearchResults: any; getExternalIdInfos: any; getMovieRemoteSearchResults: any; getMusicAlbumRemoteSearchResults: any; getMusicArtistRemoteSearchResults: any; getMusicVideoRemoteSearchResults: any; getPersonRemoteSearchResults: any; getSeriesRemoteSearchResults: any; getTrailerRemoteSearchResults: any }

- Defined in generated-client/api/item-lookup-api.ts:629
ItemLookupApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { applySearchCriteria: any; getBookRemoteSearchResults: any; getBoxSetRemoteSearchResults: any; getExternalIdInfos: any; getMovieRemoteSearchResults: any; getMusicAlbumRemoteSearchResults: any; getMusicArtistRemoteSearchResults: any; getMusicVideoRemoteSearchResults: any; getPersonRemoteSearchResults: any; getSeriesRemoteSearchResults: any; getTrailerRemoteSearchResults: any }
- applySearchCriteria:function
  - applySearchCriteria(itemId: string, remoteSearchResult: RemoteSearchResult, replaceAllImages?: boolean, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/item-lookup-api.ts:641
    summary
    Applies search criteria to an item and refreshes metadata.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - remoteSearchResult: RemoteSearchResult
      The remote search result.
    - Optional replaceAllImages: boolean
    - Optional options: any
    Returns AxiosPromise<void>
- getBookRemoteSearchResults:function
  - getBookRemoteSearchResults(bookInfoRemoteSearchQuery: BookInfoRemoteSearchQuery, options?: any): AxiosPromise<RemoteSearchResult[]>
  - - Defined in generated-client/api/item-lookup-api.ts:651
    summary
    Get book remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - bookInfoRemoteSearchQuery: BookInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns AxiosPromise<RemoteSearchResult[]>
- getBoxSetRemoteSearchResults:function
  - getBoxSetRemoteSearchResults(boxSetInfoRemoteSearchQuery: BoxSetInfoRemoteSearchQuery, options?: any): AxiosPromise<RemoteSearchResult[]>
  - - Defined in generated-client/api/item-lookup-api.ts:661
    summary
    Get box set remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - boxSetInfoRemoteSearchQuery: BoxSetInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns AxiosPromise<RemoteSearchResult[]>
- getExternalIdInfos:function
  - getExternalIdInfos(itemId: string, options?: any): AxiosPromise<ExternalIdInfo[]>
  - - Defined in generated-client/api/item-lookup-api.ts:671
    summary
    Get the item's external id info.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - Optional options: any
    Returns AxiosPromise<ExternalIdInfo[]>
- getMovieRemoteSearchResults:function
  - getMovieRemoteSearchResults(movieInfoRemoteSearchQuery: MovieInfoRemoteSearchQuery, options?: any): AxiosPromise<RemoteSearchResult[]>
  - - Defined in generated-client/api/item-lookup-api.ts:681
    summary
    Get movie remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - movieInfoRemoteSearchQuery: MovieInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns AxiosPromise<RemoteSearchResult[]>
- getMusicAlbumRemoteSearchResults:function
  - getMusicAlbumRemoteSearchResults(albumInfoRemoteSearchQuery: AlbumInfoRemoteSearchQuery, options?: any): AxiosPromise<RemoteSearchResult[]>
  - - Defined in generated-client/api/item-lookup-api.ts:691
    summary
    Get music album remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - albumInfoRemoteSearchQuery: AlbumInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns AxiosPromise<RemoteSearchResult[]>
- getMusicArtistRemoteSearchResults:function
  - getMusicArtistRemoteSearchResults(artistInfoRemoteSearchQuery: ArtistInfoRemoteSearchQuery, options?: any): AxiosPromise<RemoteSearchResult[]>
  - - Defined in generated-client/api/item-lookup-api.ts:701
    summary
    Get music artist remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - artistInfoRemoteSearchQuery: ArtistInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns AxiosPromise<RemoteSearchResult[]>
- getMusicVideoRemoteSearchResults:function
  - getMusicVideoRemoteSearchResults(musicVideoInfoRemoteSearchQuery: MusicVideoInfoRemoteSearchQuery, options?: any): AxiosPromise<RemoteSearchResult[]>
  - - Defined in generated-client/api/item-lookup-api.ts:711
    summary
    Get music video remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - musicVideoInfoRemoteSearchQuery: MusicVideoInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns AxiosPromise<RemoteSearchResult[]>
- getPersonRemoteSearchResults:function
  - getPersonRemoteSearchResults(personLookupInfoRemoteSearchQuery: PersonLookupInfoRemoteSearchQuery, options?: any): AxiosPromise<RemoteSearchResult[]>
  - - Defined in generated-client/api/item-lookup-api.ts:721
    summary
    Get person remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - personLookupInfoRemoteSearchQuery: PersonLookupInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns AxiosPromise<RemoteSearchResult[]>
- getSeriesRemoteSearchResults:function
  - getSeriesRemoteSearchResults(seriesInfoRemoteSearchQuery: SeriesInfoRemoteSearchQuery, options?: any): AxiosPromise<RemoteSearchResult[]>
  - - Defined in generated-client/api/item-lookup-api.ts:731
    summary
    Get series remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - seriesInfoRemoteSearchQuery: SeriesInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns AxiosPromise<RemoteSearchResult[]>
- getTrailerRemoteSearchResults:function
  - getTrailerRemoteSearchResults(trailerInfoRemoteSearchQuery: TrailerInfoRemoteSearchQuery, options?: any): AxiosPromise<RemoteSearchResult[]>
  - - Defined in generated-client/api/item-lookup-api.ts:741
    summary
    Get trailer remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - trailerInfoRemoteSearchQuery: TrailerInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns AxiosPromise<RemoteSearchResult[]>

Const ItemLookupApiFp

ItemLookupApiFp(configuration?: Configuration): { applySearchCriteria: any; getBookRemoteSearchResults: any; getBoxSetRemoteSearchResults: any; getExternalIdInfos: any; getMovieRemoteSearchResults: any; getMusicAlbumRemoteSearchResults: any; getMusicArtistRemoteSearchResults: any; getMusicVideoRemoteSearchResults: any; getPersonRemoteSearchResults: any; getSeriesRemoteSearchResults: any; getTrailerRemoteSearchResults: any }

- Defined in generated-client/api/item-lookup-api.ts:496
ItemLookupApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { applySearchCriteria: any; getBookRemoteSearchResults: any; getBoxSetRemoteSearchResults: any; getExternalIdInfos: any; getMovieRemoteSearchResults: any; getMusicAlbumRemoteSearchResults: any; getMusicArtistRemoteSearchResults: any; getMusicVideoRemoteSearchResults: any; getPersonRemoteSearchResults: any; getSeriesRemoteSearchResults: any; getTrailerRemoteSearchResults: any }
- applySearchCriteria:function
  - applySearchCriteria(itemId: string, remoteSearchResult: RemoteSearchResult, replaceAllImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/item-lookup-api.ts:508
    summary
    Applies search criteria to an item and refreshes metadata.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - remoteSearchResult: RemoteSearchResult
      The remote search result.
    - Optional replaceAllImages: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getBookRemoteSearchResults:function
  - getBookRemoteSearchResults(bookInfoRemoteSearchQuery: BookInfoRemoteSearchQuery, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
  - - Defined in generated-client/api/item-lookup-api.ts:519
    summary
    Get book remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - bookInfoRemoteSearchQuery: BookInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
- getBoxSetRemoteSearchResults:function
  - getBoxSetRemoteSearchResults(boxSetInfoRemoteSearchQuery: BoxSetInfoRemoteSearchQuery, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
  - - Defined in generated-client/api/item-lookup-api.ts:530
    summary
    Get box set remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - boxSetInfoRemoteSearchQuery: BoxSetInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
- getExternalIdInfos:function
  - getExternalIdInfos(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExternalIdInfo[]>>
  - - Defined in generated-client/api/item-lookup-api.ts:541
    summary
    Get the item's external id info.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExternalIdInfo[]>>
- getMovieRemoteSearchResults:function
  - getMovieRemoteSearchResults(movieInfoRemoteSearchQuery: MovieInfoRemoteSearchQuery, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
  - - Defined in generated-client/api/item-lookup-api.ts:552
    summary
    Get movie remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - movieInfoRemoteSearchQuery: MovieInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
- getMusicAlbumRemoteSearchResults:function
  - getMusicAlbumRemoteSearchResults(albumInfoRemoteSearchQuery: AlbumInfoRemoteSearchQuery, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
  - - Defined in generated-client/api/item-lookup-api.ts:563
    summary
    Get music album remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - albumInfoRemoteSearchQuery: AlbumInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
- getMusicArtistRemoteSearchResults:function
  - getMusicArtistRemoteSearchResults(artistInfoRemoteSearchQuery: ArtistInfoRemoteSearchQuery, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
  - - Defined in generated-client/api/item-lookup-api.ts:574
    summary
    Get music artist remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - artistInfoRemoteSearchQuery: ArtistInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
- getMusicVideoRemoteSearchResults:function
  - getMusicVideoRemoteSearchResults(musicVideoInfoRemoteSearchQuery: MusicVideoInfoRemoteSearchQuery, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
  - - Defined in generated-client/api/item-lookup-api.ts:585
    summary
    Get music video remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - musicVideoInfoRemoteSearchQuery: MusicVideoInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
- getPersonRemoteSearchResults:function
  - getPersonRemoteSearchResults(personLookupInfoRemoteSearchQuery: PersonLookupInfoRemoteSearchQuery, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
  - - Defined in generated-client/api/item-lookup-api.ts:596
    summary
    Get person remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - personLookupInfoRemoteSearchQuery: PersonLookupInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
- getSeriesRemoteSearchResults:function
  - getSeriesRemoteSearchResults(seriesInfoRemoteSearchQuery: SeriesInfoRemoteSearchQuery, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
  - - Defined in generated-client/api/item-lookup-api.ts:607
    summary
    Get series remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - seriesInfoRemoteSearchQuery: SeriesInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
- getTrailerRemoteSearchResults:function
  - getTrailerRemoteSearchResults(trailerInfoRemoteSearchQuery: TrailerInfoRemoteSearchQuery, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>
  - - Defined in generated-client/api/item-lookup-api.ts:618
    summary
    Get trailer remote search.
    
    throws
    {RequiredError}
    
    Parameters
    - trailerInfoRemoteSearchQuery: TrailerInfoRemoteSearchQuery
      Remote search query.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSearchResult[]>>

Const ItemRefreshApiAxiosParamCreator

ItemRefreshApiAxiosParamCreator(configuration?: Configuration): { post: (itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/item-refresh-api.ts:31
ItemRefreshApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { post: (itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, options?: any) => Promise<RequestArgs> }
- post: (itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, options?: any) => Promise<RequestArgs>
  - - (itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Refreshes metadata for an item.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item id.
      - Optional metadataRefreshMode: MetadataRefreshMode
      - Optional imageRefreshMode: MetadataRefreshMode
      - Optional replaceAllMetadata: boolean
      - Optional replaceAllImages: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const ItemRefreshApiFactory

ItemRefreshApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { post: any }

- Defined in generated-client/api/item-refresh-api.ts:122
ItemRefreshApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { post: any }
- post:function
  - post(itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/item-refresh-api.ts:136
    summary
    Refreshes metadata for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - Optional metadataRefreshMode: MetadataRefreshMode
    - Optional imageRefreshMode: MetadataRefreshMode
    - Optional replaceAllMetadata: boolean
    - Optional replaceAllImages: boolean
    - Optional options: any
    Returns AxiosPromise<void>

Const ItemRefreshApiFp

ItemRefreshApiFp(configuration?: Configuration): { post: any }

- Defined in generated-client/api/item-refresh-api.ts:97
ItemRefreshApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { post: any }
- post:function
  - post(itemId: string, metadataRefreshMode?: MetadataRefreshMode, imageRefreshMode?: MetadataRefreshMode, replaceAllMetadata?: boolean, replaceAllImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/item-refresh-api.ts:111
    summary
    Refreshes metadata for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item id.
    - Optional metadataRefreshMode: MetadataRefreshMode
    - Optional imageRefreshMode: MetadataRefreshMode
    - Optional replaceAllMetadata: boolean
    - Optional replaceAllImages: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const ItemUpdateApiAxiosParamCreator

ItemUpdateApiAxiosParamCreator(configuration?: Configuration): { getMetadataEditorInfo: (itemId: string, options?: any) => Promise<RequestArgs>; updateItem: (itemId: string, baseItemDto: BaseItemDto, options?: any) => Promise<RequestArgs>; updateItemContentType: (itemId: string, contentType?: string, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/item-update-api.ts:33
ItemUpdateApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getMetadataEditorInfo: (itemId: string, options?: any) => Promise<RequestArgs>; updateItem: (itemId: string, baseItemDto: BaseItemDto, options?: any) => Promise<RequestArgs>; updateItemContentType: (itemId: string, contentType?: string, options?: any) => Promise<RequestArgs> }
- getMetadataEditorInfo: (itemId: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets metadata editor info for an item.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - options: any = {}
      Returns Promise<RequestArgs>
- updateItem: (itemId: string, baseItemDto: BaseItemDto, options?: any) => Promise<RequestArgs>
  - - (itemId: string, baseItemDto: BaseItemDto, options?: any): Promise<RequestArgs>
    - summary
      Updates an item.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - baseItemDto: BaseItemDto
        The new item properties.
      - options: any = {}
      Returns Promise<RequestArgs>
- updateItemContentType: (itemId: string, contentType?: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, contentType?: string, options?: any): Promise<RequestArgs>
    - summary
      Updates an item's content type.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional contentType: string
      - options: any = {}
      Returns Promise<RequestArgs>

Const ItemUpdateApiFactory

ItemUpdateApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getMetadataEditorInfo: any; updateItem: any; updateItemContentType: any }

- Defined in generated-client/api/item-update-api.ts:209
ItemUpdateApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getMetadataEditorInfo: any; updateItem: any; updateItemContentType: any }
- getMetadataEditorInfo:function
  - getMetadataEditorInfo(itemId: string, options?: any): AxiosPromise<MetadataEditorInfo>
  - - Defined in generated-client/api/item-update-api.ts:219
    summary
    Gets metadata editor info for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional options: any
    Returns AxiosPromise<MetadataEditorInfo>
- updateItem:function
  - updateItem(itemId: string, baseItemDto: BaseItemDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/item-update-api.ts:230
    summary
    Updates an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - baseItemDto: BaseItemDto
      The new item properties.
    - Optional options: any
    Returns AxiosPromise<void>
- updateItemContentType:function
  - updateItemContentType(itemId: string, contentType?: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/item-update-api.ts:241
    summary
    Updates an item's content type.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional contentType: string
    - Optional options: any
    Returns AxiosPromise<void>

Const ItemUpdateApiFp

ItemUpdateApiFp(configuration?: Configuration): { getMetadataEditorInfo: any; updateItem: any; updateItemContentType: any }

- Defined in generated-client/api/item-update-api.ts:164
ItemUpdateApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getMetadataEditorInfo: any; updateItem: any; updateItemContentType: any }
- getMetadataEditorInfo:function
  - getMetadataEditorInfo(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataEditorInfo>>
  - - Defined in generated-client/api/item-update-api.ts:174
    summary
    Gets metadata editor info for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetadataEditorInfo>>
- updateItem:function
  - updateItem(itemId: string, baseItemDto: BaseItemDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/item-update-api.ts:186
    summary
    Updates an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - baseItemDto: BaseItemDto
      The new item properties.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- updateItemContentType:function
  - updateItemContentType(itemId: string, contentType?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/item-update-api.ts:198
    summary
    Updates an item's content type.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional contentType: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const ItemsApiAxiosParamCreator

ItemsApiAxiosParamCreator(configuration?: Configuration): { getItems: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>; getItemsByUserId: (userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>; getResumeItems: (userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], mediaTypes?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludeItemTypes?: string[], includeItemTypes?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/items-api.ts:43
ItemsApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getItems: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>; getItemsByUserId: (userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>; getResumeItems: (userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], mediaTypes?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludeItemTypes?: string[], includeItemTypes?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs> }
- getItems: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>
  - - (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets items based on a query.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional userId: string
      - Optional maxOfficialRating: string
      - Optional hasThemeSong: boolean
      - Optional hasThemeVideo: boolean
      - Optional hasSubtitles: boolean
      - Optional hasSpecialFeature: boolean
      - Optional hasTrailer: boolean
      - Optional adjacentTo: string
      - Optional parentIndexNumber: number
      - Optional hasParentalRating: boolean
      - Optional isHd: boolean
      - Optional is4K: boolean
      - Optional locationTypes: LocationType[]
      - Optional excludeLocationTypes: LocationType[]
      - Optional isMissing: boolean
      - Optional isUnaired: boolean
      - Optional minCommunityRating: number
      - Optional minCriticRating: number
      - Optional minPremiereDate: string
      - Optional minDateLastSaved: string
      - Optional minDateLastSavedForUser: string
      - Optional maxPremiereDate: string
      - Optional hasOverview: boolean
      - Optional hasImdbId: boolean
      - Optional hasTmdbId: boolean
      - Optional hasTvdbId: boolean
      - Optional excludeItemIds: string[]
      - Optional startIndex: number
      - Optional limit: number
      - Optional recursive: boolean
      - Optional searchTerm: string
      - Optional sortOrder: SortOrder[]
      - Optional parentId: string
      - Optional fields: ItemFields[]
      - Optional excludeItemTypes: string[]
      - Optional includeItemTypes: string[]
      - Optional filters: ItemFilter[]
      - Optional isFavorite: boolean
      - Optional mediaTypes: string[]
      - Optional imageTypes: ImageType[]
      - Optional sortBy: string[]
      - Optional isPlayed: boolean
      - Optional genres: string[]
      - Optional officialRatings: string[]
      - Optional tags: string[]
      - Optional years: number[]
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional person: string
      - Optional personIds: string[]
      - Optional personTypes: string[]
      - Optional studios: string[]
      - Optional artists: string[]
      - Optional excludeArtistIds: string[]
      - Optional artistIds: string[]
      - Optional albumArtistIds: string[]
      - Optional contributingArtistIds: string[]
      - Optional albums: string[]
      - Optional albumIds: string[]
      - Optional ids: string[]
      - Optional videoTypes: VideoType[]
      - Optional minOfficialRating: string
      - Optional isLocked: boolean
      - Optional isPlaceHolder: boolean
      - Optional hasOfficialRating: boolean
      - Optional collapseBoxSetItems: boolean
      - Optional minWidth: number
      - Optional minHeight: number
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional is3D: boolean
      - Optional seriesStatus: SeriesStatus[]
      - Optional nameStartsWithOrGreater: string
      - Optional nameStartsWith: string
      - Optional nameLessThan: string
      - Optional studioIds: string[]
      - Optional genreIds: string[]
      - Optional enableTotalRecordCount: boolean
      - Optional enableImages: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getItemsByUserId: (userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>
  - - (userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets items based on a query.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        The user id supplied as query parameter.
      - Optional maxOfficialRating: string
      - Optional hasThemeSong: boolean
      - Optional hasThemeVideo: boolean
      - Optional hasSubtitles: boolean
      - Optional hasSpecialFeature: boolean
      - Optional hasTrailer: boolean
      - Optional adjacentTo: string
      - Optional parentIndexNumber: number
      - Optional hasParentalRating: boolean
      - Optional isHd: boolean
      - Optional is4K: boolean
      - Optional locationTypes: LocationType[]
      - Optional excludeLocationTypes: LocationType[]
      - Optional isMissing: boolean
      - Optional isUnaired: boolean
      - Optional minCommunityRating: number
      - Optional minCriticRating: number
      - Optional minPremiereDate: string
      - Optional minDateLastSaved: string
      - Optional minDateLastSavedForUser: string
      - Optional maxPremiereDate: string
      - Optional hasOverview: boolean
      - Optional hasImdbId: boolean
      - Optional hasTmdbId: boolean
      - Optional hasTvdbId: boolean
      - Optional excludeItemIds: string[]
      - Optional startIndex: number
      - Optional limit: number
      - Optional recursive: boolean
      - Optional searchTerm: string
      - Optional sortOrder: SortOrder[]
      - Optional parentId: string
      - Optional fields: ItemFields[]
      - Optional excludeItemTypes: string[]
      - Optional includeItemTypes: string[]
      - Optional filters: ItemFilter[]
      - Optional isFavorite: boolean
      - Optional mediaTypes: string[]
      - Optional imageTypes: ImageType[]
      - Optional sortBy: string[]
      - Optional isPlayed: boolean
      - Optional genres: string[]
      - Optional officialRatings: string[]
      - Optional tags: string[]
      - Optional years: number[]
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional person: string
      - Optional personIds: string[]
      - Optional personTypes: string[]
      - Optional studios: string[]
      - Optional artists: string[]
      - Optional excludeArtistIds: string[]
      - Optional artistIds: string[]
      - Optional albumArtistIds: string[]
      - Optional contributingArtistIds: string[]
      - Optional albums: string[]
      - Optional albumIds: string[]
      - Optional ids: string[]
      - Optional videoTypes: VideoType[]
      - Optional minOfficialRating: string
      - Optional isLocked: boolean
      - Optional isPlaceHolder: boolean
      - Optional hasOfficialRating: boolean
      - Optional collapseBoxSetItems: boolean
      - Optional minWidth: number
      - Optional minHeight: number
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional is3D: boolean
      - Optional seriesStatus: SeriesStatus[]
      - Optional nameStartsWithOrGreater: string
      - Optional nameStartsWith: string
      - Optional nameLessThan: string
      - Optional studioIds: string[]
      - Optional genreIds: string[]
      - Optional enableTotalRecordCount: boolean
      - Optional enableImages: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getResumeItems: (userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], mediaTypes?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludeItemTypes?: string[], includeItemTypes?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>
  - - (userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], mediaTypes?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludeItemTypes?: string[], includeItemTypes?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets items based on a query.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        The user id.
      - Optional startIndex: number
      - Optional limit: number
      - Optional searchTerm: string
      - Optional parentId: string
      - Optional fields: ItemFields[]
      - Optional mediaTypes: string[]
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional excludeItemTypes: string[]
      - Optional includeItemTypes: string[]
      - Optional enableTotalRecordCount: boolean
      - Optional enableImages: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const ItemsApiFactory

ItemsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getItems: any; getItemsByUserId: any; getResumeItems: any }

- Defined in generated-client/api/items-api.ts:1249
ItemsApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getItems: any; getItemsByUserId: any; getResumeItems: any }
- getItems:function
  - getItems(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/items-api.ts:1338
    summary
    Gets items based on a query.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional maxOfficialRating: string
    - Optional hasThemeSong: boolean
    - Optional hasThemeVideo: boolean
    - Optional hasSubtitles: boolean
    - Optional hasSpecialFeature: boolean
    - Optional hasTrailer: boolean
    - Optional adjacentTo: string
    - Optional parentIndexNumber: number
    - Optional hasParentalRating: boolean
    - Optional isHd: boolean
    - Optional is4K: boolean
    - Optional locationTypes: LocationType[]
    - Optional excludeLocationTypes: LocationType[]
    - Optional isMissing: boolean
    - Optional isUnaired: boolean
    - Optional minCommunityRating: number
    - Optional minCriticRating: number
    - Optional minPremiereDate: string
    - Optional minDateLastSaved: string
    - Optional minDateLastSavedForUser: string
    - Optional maxPremiereDate: string
    - Optional hasOverview: boolean
    - Optional hasImdbId: boolean
    - Optional hasTmdbId: boolean
    - Optional hasTvdbId: boolean
    - Optional excludeItemIds: string[]
    - Optional startIndex: number
    - Optional limit: number
    - Optional recursive: boolean
    - Optional searchTerm: string
    - Optional sortOrder: SortOrder[]
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional filters: ItemFilter[]
    - Optional isFavorite: boolean
    - Optional mediaTypes: string[]
    - Optional imageTypes: ImageType[]
    - Optional sortBy: string[]
    - Optional isPlayed: boolean
    - Optional genres: string[]
    - Optional officialRatings: string[]
    - Optional tags: string[]
    - Optional years: number[]
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional person: string
    - Optional personIds: string[]
    - Optional personTypes: string[]
    - Optional studios: string[]
    - Optional artists: string[]
    - Optional excludeArtistIds: string[]
    - Optional artistIds: string[]
    - Optional albumArtistIds: string[]
    - Optional contributingArtistIds: string[]
    - Optional albums: string[]
    - Optional albumIds: string[]
    - Optional ids: string[]
    - Optional videoTypes: VideoType[]
    - Optional minOfficialRating: string
    - Optional isLocked: boolean
    - Optional isPlaceHolder: boolean
    - Optional hasOfficialRating: boolean
    - Optional collapseBoxSetItems: boolean
    - Optional minWidth: number
    - Optional minHeight: number
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional is3D: boolean
    - Optional seriesStatus: SeriesStatus[]
    - Optional nameStartsWithOrGreater: string
    - Optional nameStartsWith: string
    - Optional nameLessThan: string
    - Optional studioIds: string[]
    - Optional genreIds: string[]
    - Optional enableTotalRecordCount: boolean
    - Optional enableImages: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getItemsByUserId:function
  - getItemsByUserId(userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/items-api.ts:1427
    summary
    Gets items based on a query.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id supplied as query parameter.
    - Optional maxOfficialRating: string
    - Optional hasThemeSong: boolean
    - Optional hasThemeVideo: boolean
    - Optional hasSubtitles: boolean
    - Optional hasSpecialFeature: boolean
    - Optional hasTrailer: boolean
    - Optional adjacentTo: string
    - Optional parentIndexNumber: number
    - Optional hasParentalRating: boolean
    - Optional isHd: boolean
    - Optional is4K: boolean
    - Optional locationTypes: LocationType[]
    - Optional excludeLocationTypes: LocationType[]
    - Optional isMissing: boolean
    - Optional isUnaired: boolean
    - Optional minCommunityRating: number
    - Optional minCriticRating: number
    - Optional minPremiereDate: string
    - Optional minDateLastSaved: string
    - Optional minDateLastSavedForUser: string
    - Optional maxPremiereDate: string
    - Optional hasOverview: boolean
    - Optional hasImdbId: boolean
    - Optional hasTmdbId: boolean
    - Optional hasTvdbId: boolean
    - Optional excludeItemIds: string[]
    - Optional startIndex: number
    - Optional limit: number
    - Optional recursive: boolean
    - Optional searchTerm: string
    - Optional sortOrder: SortOrder[]
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional filters: ItemFilter[]
    - Optional isFavorite: boolean
    - Optional mediaTypes: string[]
    - Optional imageTypes: ImageType[]
    - Optional sortBy: string[]
    - Optional isPlayed: boolean
    - Optional genres: string[]
    - Optional officialRatings: string[]
    - Optional tags: string[]
    - Optional years: number[]
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional person: string
    - Optional personIds: string[]
    - Optional personTypes: string[]
    - Optional studios: string[]
    - Optional artists: string[]
    - Optional excludeArtistIds: string[]
    - Optional artistIds: string[]
    - Optional albumArtistIds: string[]
    - Optional contributingArtistIds: string[]
    - Optional albums: string[]
    - Optional albumIds: string[]
    - Optional ids: string[]
    - Optional videoTypes: VideoType[]
    - Optional minOfficialRating: string
    - Optional isLocked: boolean
    - Optional isPlaceHolder: boolean
    - Optional hasOfficialRating: boolean
    - Optional collapseBoxSetItems: boolean
    - Optional minWidth: number
    - Optional minHeight: number
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional is3D: boolean
    - Optional seriesStatus: SeriesStatus[]
    - Optional nameStartsWithOrGreater: string
    - Optional nameStartsWith: string
    - Optional nameLessThan: string
    - Optional studioIds: string[]
    - Optional genreIds: string[]
    - Optional enableTotalRecordCount: boolean
    - Optional enableImages: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getResumeItems:function
  - getResumeItems(userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], mediaTypes?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludeItemTypes?: string[], includeItemTypes?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/items-api.ts:1450
    summary
    Gets items based on a query.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - Optional startIndex: number
    - Optional limit: number
    - Optional searchTerm: string
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional mediaTypes: string[]
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional enableTotalRecordCount: boolean
    - Optional enableImages: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>

Const ItemsApiFp

ItemsApiFp(configuration?: Configuration): { getItems: any; getItemsByUserId: any; getResumeItems: any }

- Defined in generated-client/api/items-api.ts:1035
ItemsApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getItems: any; getItemsByUserId: any; getResumeItems: any }
- getItems:function
  - getItems(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/items-api.ts:1124
    summary
    Gets items based on a query.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional maxOfficialRating: string
    - Optional hasThemeSong: boolean
    - Optional hasThemeVideo: boolean
    - Optional hasSubtitles: boolean
    - Optional hasSpecialFeature: boolean
    - Optional hasTrailer: boolean
    - Optional adjacentTo: string
    - Optional parentIndexNumber: number
    - Optional hasParentalRating: boolean
    - Optional isHd: boolean
    - Optional is4K: boolean
    - Optional locationTypes: LocationType[]
    - Optional excludeLocationTypes: LocationType[]
    - Optional isMissing: boolean
    - Optional isUnaired: boolean
    - Optional minCommunityRating: number
    - Optional minCriticRating: number
    - Optional minPremiereDate: string
    - Optional minDateLastSaved: string
    - Optional minDateLastSavedForUser: string
    - Optional maxPremiereDate: string
    - Optional hasOverview: boolean
    - Optional hasImdbId: boolean
    - Optional hasTmdbId: boolean
    - Optional hasTvdbId: boolean
    - Optional excludeItemIds: string[]
    - Optional startIndex: number
    - Optional limit: number
    - Optional recursive: boolean
    - Optional searchTerm: string
    - Optional sortOrder: SortOrder[]
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional filters: ItemFilter[]
    - Optional isFavorite: boolean
    - Optional mediaTypes: string[]
    - Optional imageTypes: ImageType[]
    - Optional sortBy: string[]
    - Optional isPlayed: boolean
    - Optional genres: string[]
    - Optional officialRatings: string[]
    - Optional tags: string[]
    - Optional years: number[]
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional person: string
    - Optional personIds: string[]
    - Optional personTypes: string[]
    - Optional studios: string[]
    - Optional artists: string[]
    - Optional excludeArtistIds: string[]
    - Optional artistIds: string[]
    - Optional albumArtistIds: string[]
    - Optional contributingArtistIds: string[]
    - Optional albums: string[]
    - Optional albumIds: string[]
    - Optional ids: string[]
    - Optional videoTypes: VideoType[]
    - Optional minOfficialRating: string
    - Optional isLocked: boolean
    - Optional isPlaceHolder: boolean
    - Optional hasOfficialRating: boolean
    - Optional collapseBoxSetItems: boolean
    - Optional minWidth: number
    - Optional minHeight: number
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional is3D: boolean
    - Optional seriesStatus: SeriesStatus[]
    - Optional nameStartsWithOrGreater: string
    - Optional nameStartsWith: string
    - Optional nameLessThan: string
    - Optional studioIds: string[]
    - Optional genreIds: string[]
    - Optional enableTotalRecordCount: boolean
    - Optional enableImages: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getItemsByUserId:function
  - getItemsByUserId(userId: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/items-api.ts:1214
    summary
    Gets items based on a query.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id supplied as query parameter.
    - Optional maxOfficialRating: string
    - Optional hasThemeSong: boolean
    - Optional hasThemeVideo: boolean
    - Optional hasSubtitles: boolean
    - Optional hasSpecialFeature: boolean
    - Optional hasTrailer: boolean
    - Optional adjacentTo: string
    - Optional parentIndexNumber: number
    - Optional hasParentalRating: boolean
    - Optional isHd: boolean
    - Optional is4K: boolean
    - Optional locationTypes: LocationType[]
    - Optional excludeLocationTypes: LocationType[]
    - Optional isMissing: boolean
    - Optional isUnaired: boolean
    - Optional minCommunityRating: number
    - Optional minCriticRating: number
    - Optional minPremiereDate: string
    - Optional minDateLastSaved: string
    - Optional minDateLastSavedForUser: string
    - Optional maxPremiereDate: string
    - Optional hasOverview: boolean
    - Optional hasImdbId: boolean
    - Optional hasTmdbId: boolean
    - Optional hasTvdbId: boolean
    - Optional excludeItemIds: string[]
    - Optional startIndex: number
    - Optional limit: number
    - Optional recursive: boolean
    - Optional searchTerm: string
    - Optional sortOrder: SortOrder[]
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional filters: ItemFilter[]
    - Optional isFavorite: boolean
    - Optional mediaTypes: string[]
    - Optional imageTypes: ImageType[]
    - Optional sortBy: string[]
    - Optional isPlayed: boolean
    - Optional genres: string[]
    - Optional officialRatings: string[]
    - Optional tags: string[]
    - Optional years: number[]
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional person: string
    - Optional personIds: string[]
    - Optional personTypes: string[]
    - Optional studios: string[]
    - Optional artists: string[]
    - Optional excludeArtistIds: string[]
    - Optional artistIds: string[]
    - Optional albumArtistIds: string[]
    - Optional contributingArtistIds: string[]
    - Optional albums: string[]
    - Optional albumIds: string[]
    - Optional ids: string[]
    - Optional videoTypes: VideoType[]
    - Optional minOfficialRating: string
    - Optional isLocked: boolean
    - Optional isPlaceHolder: boolean
    - Optional hasOfficialRating: boolean
    - Optional collapseBoxSetItems: boolean
    - Optional minWidth: number
    - Optional minHeight: number
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional is3D: boolean
    - Optional seriesStatus: SeriesStatus[]
    - Optional nameStartsWithOrGreater: string
    - Optional nameStartsWith: string
    - Optional nameLessThan: string
    - Optional studioIds: string[]
    - Optional genreIds: string[]
    - Optional enableTotalRecordCount: boolean
    - Optional enableImages: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getResumeItems:function
  - getResumeItems(userId: string, startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], mediaTypes?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludeItemTypes?: string[], includeItemTypes?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/items-api.ts:1238
    summary
    Gets items based on a query.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - Optional startIndex: number
    - Optional limit: number
    - Optional searchTerm: string
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional mediaTypes: string[]
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional enableTotalRecordCount: boolean
    - Optional enableImages: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>

Const LibraryApiAxiosParamCreator

LibraryApiAxiosParamCreator(configuration?: Configuration): { deleteItem: (itemId: string, options?: any) => Promise<RequestArgs>; deleteItems: (ids?: string[], options?: any) => Promise<RequestArgs>; getAncestors: (itemId: string, userId?: string, options?: any) => Promise<RequestArgs>; getCriticReviews: (itemId: string, options?: any) => Promise<RequestArgs>; getDownload: (itemId: string, options?: any) => Promise<RequestArgs>; getFile: (itemId: string, options?: any) => Promise<RequestArgs>; getItemCounts: (userId?: string, isFavorite?: boolean, options?: any) => Promise<RequestArgs>; getLibraryOptionsInfo: (libraryContentType?: string, isNewLibrary?: boolean, options?: any) => Promise<RequestArgs>; getMediaFolders: (isHidden?: boolean, options?: any) => Promise<RequestArgs>; getPhysicalPaths: (options?: any) => Promise<RequestArgs>; getSimilarAlbums: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarArtists: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarItems: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarMovies: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarShows: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarTrailers: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getThemeMedia: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>; getThemeSongs: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>; getThemeVideos: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>; postAddedMovies: (tmdbId?: string, imdbId?: string, options?: any) => Promise<RequestArgs>; postAddedSeries: (tvdbId?: string, options?: any) => Promise<RequestArgs>; postUpdatedMedia: (mediaUpdateInfoDto: MediaUpdateInfoDto, options?: any) => Promise<RequestArgs>; postUpdatedMovies: (tmdbId?: string, imdbId?: string, options?: any) => Promise<RequestArgs>; postUpdatedSeries: (tvdbId?: string, options?: any) => Promise<RequestArgs>; refreshLibrary: (options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/library-api.ts:45
LibraryApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { deleteItem: (itemId: string, options?: any) => Promise<RequestArgs>; deleteItems: (ids?: string[], options?: any) => Promise<RequestArgs>; getAncestors: (itemId: string, userId?: string, options?: any) => Promise<RequestArgs>; getCriticReviews: (itemId: string, options?: any) => Promise<RequestArgs>; getDownload: (itemId: string, options?: any) => Promise<RequestArgs>; getFile: (itemId: string, options?: any) => Promise<RequestArgs>; getItemCounts: (userId?: string, isFavorite?: boolean, options?: any) => Promise<RequestArgs>; getLibraryOptionsInfo: (libraryContentType?: string, isNewLibrary?: boolean, options?: any) => Promise<RequestArgs>; getMediaFolders: (isHidden?: boolean, options?: any) => Promise<RequestArgs>; getPhysicalPaths: (options?: any) => Promise<RequestArgs>; getSimilarAlbums: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarArtists: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarItems: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarMovies: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarShows: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getSimilarTrailers: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>; getThemeMedia: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>; getThemeSongs: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>; getThemeVideos: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>; postAddedMovies: (tmdbId?: string, imdbId?: string, options?: any) => Promise<RequestArgs>; postAddedSeries: (tvdbId?: string, options?: any) => Promise<RequestArgs>; postUpdatedMedia: (mediaUpdateInfoDto: MediaUpdateInfoDto, options?: any) => Promise<RequestArgs>; postUpdatedMovies: (tmdbId?: string, imdbId?: string, options?: any) => Promise<RequestArgs>; postUpdatedSeries: (tvdbId?: string, options?: any) => Promise<RequestArgs>; refreshLibrary: (options?: any) => Promise<RequestArgs> }
- deleteItem: (itemId: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Deletes an item from the library and filesystem.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - options: any = {}
      Returns Promise<RequestArgs>
- deleteItems: (ids?: string[], options?: any) => Promise<RequestArgs>
  - - (ids?: string[], options?: any): Promise<RequestArgs>
    - summary
      Deletes items from the library and filesystem.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional ids: string[]
      - options: any = {}
      Returns Promise<RequestArgs>
- getAncestors: (itemId: string, userId?: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, userId?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets all parents of an item.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getCriticReviews: (itemId: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets critic review for an item.
      
      deprecated
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getDownload: (itemId: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Downloads item media.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getFile: (itemId: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Get the original file of an item.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getItemCounts: (userId?: string, isFavorite?: boolean, options?: any) => Promise<RequestArgs>
  - - (userId?: string, isFavorite?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Get item counts.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional userId: string
      - Optional isFavorite: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getLibraryOptionsInfo: (libraryContentType?: string, isNewLibrary?: boolean, options?: any) => Promise<RequestArgs>
  - - (libraryContentType?: string, isNewLibrary?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets the library options info.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional libraryContentType: string
      - Optional isNewLibrary: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getMediaFolders: (isHidden?: boolean, options?: any) => Promise<RequestArgs>
  - - (isHidden?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets all user media folders.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional isHidden: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getPhysicalPaths: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets a list of physical paths from virtual folders.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getSimilarAlbums: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>
  - - (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<RequestArgs>
    - summary
      Gets similar items.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional excludeArtistIds: string[]
      - Optional userId: string
      - Optional limit: number
      - Optional fields: ItemFields[]
      - options: any = {}
      Returns Promise<RequestArgs>
- getSimilarArtists: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>
  - - (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<RequestArgs>
    - summary
      Gets similar items.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional excludeArtistIds: string[]
      - Optional userId: string
      - Optional limit: number
      - Optional fields: ItemFields[]
      - options: any = {}
      Returns Promise<RequestArgs>
- getSimilarItems: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>
  - - (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<RequestArgs>
    - summary
      Gets similar items.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional excludeArtistIds: string[]
      - Optional userId: string
      - Optional limit: number
      - Optional fields: ItemFields[]
      - options: any = {}
      Returns Promise<RequestArgs>
- getSimilarMovies: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>
  - - (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<RequestArgs>
    - summary
      Gets similar items.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional excludeArtistIds: string[]
      - Optional userId: string
      - Optional limit: number
      - Optional fields: ItemFields[]
      - options: any = {}
      Returns Promise<RequestArgs>
- getSimilarShows: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>
  - - (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<RequestArgs>
    - summary
      Gets similar items.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional excludeArtistIds: string[]
      - Optional userId: string
      - Optional limit: number
      - Optional fields: ItemFields[]
      - options: any = {}
      Returns Promise<RequestArgs>
- getSimilarTrailers: (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any) => Promise<RequestArgs>
  - - (itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<RequestArgs>
    - summary
      Gets similar items.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional excludeArtistIds: string[]
      - Optional userId: string
      - Optional limit: number
      - Optional fields: ItemFields[]
      - options: any = {}
      Returns Promise<RequestArgs>
- getThemeMedia: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>
  - - (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Get theme songs and videos for an item.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional userId: string
      - Optional inheritFromParent: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getThemeSongs: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>
  - - (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Get theme songs for an item.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional userId: string
      - Optional inheritFromParent: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getThemeVideos: (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any) => Promise<RequestArgs>
  - - (itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Get theme videos for an item.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional userId: string
      - Optional inheritFromParent: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- postAddedMovies: (tmdbId?: string, imdbId?: string, options?: any) => Promise<RequestArgs>
  - - (tmdbId?: string, imdbId?: string, options?: any): Promise<RequestArgs>
    - summary
      Reports that new movies have been added by an external source.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional tmdbId: string
      - Optional imdbId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- postAddedSeries: (tvdbId?: string, options?: any) => Promise<RequestArgs>
  - - (tvdbId?: string, options?: any): Promise<RequestArgs>
    - summary
      Reports that new episodes of a series have been added by an external source.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional tvdbId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- postUpdatedMedia: (mediaUpdateInfoDto: MediaUpdateInfoDto, options?: any) => Promise<RequestArgs>
  - - (mediaUpdateInfoDto: MediaUpdateInfoDto, options?: any): Promise<RequestArgs>
    - summary
      Reports that new movies have been added by an external source.
      
      throws
      {RequiredError}
      
      Parameters
      - mediaUpdateInfoDto: MediaUpdateInfoDto
        The update paths.
      - options: any = {}
      Returns Promise<RequestArgs>
- postUpdatedMovies: (tmdbId?: string, imdbId?: string, options?: any) => Promise<RequestArgs>
  - - (tmdbId?: string, imdbId?: string, options?: any): Promise<RequestArgs>
    - summary
      Reports that new movies have been added by an external source.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional tmdbId: string
      - Optional imdbId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- postUpdatedSeries: (tvdbId?: string, options?: any) => Promise<RequestArgs>
  - - (tvdbId?: string, options?: any): Promise<RequestArgs>
    - summary
      Reports that new episodes of a series have been added by an external source.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional tvdbId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- refreshLibrary: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Starts a library scan.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>

Const LibraryApiFactory

LibraryApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { deleteItem: any; deleteItems: any; getAncestors: any; getCriticReviews: any; getDownload: any; getFile: any; getItemCounts: any; getLibraryOptionsInfo: any; getMediaFolders: any; getPhysicalPaths: any; getSimilarAlbums: any; getSimilarArtists: any; getSimilarItems: any; getSimilarMovies: any; getSimilarShows: any; getSimilarTrailers: any; getThemeMedia: any; getThemeSongs: any; getThemeVideos: any; postAddedMovies: any; postAddedSeries: any; postUpdatedMedia: any; postUpdatedMovies: any; postUpdatedSeries: any; refreshLibrary: any }

- Defined in generated-client/api/library-api.ts:1476
LibraryApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { deleteItem: any; deleteItems: any; getAncestors: any; getCriticReviews: any; getDownload: any; getFile: any; getItemCounts: any; getLibraryOptionsInfo: any; getMediaFolders: any; getPhysicalPaths: any; getSimilarAlbums: any; getSimilarArtists: any; getSimilarItems: any; getSimilarMovies: any; getSimilarShows: any; getSimilarTrailers: any; getThemeMedia: any; getThemeSongs: any; getThemeVideos: any; postAddedMovies: any; postAddedSeries: any; postUpdatedMedia: any; postUpdatedMovies: any; postUpdatedSeries: any; refreshLibrary: any }
- deleteItem:function
  - deleteItem(itemId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/library-api.ts:1486
    summary
    Deletes an item from the library and filesystem.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional options: any
    Returns AxiosPromise<void>
- deleteItems:function
  - deleteItems(ids?: string[], options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/library-api.ts:1496
    summary
    Deletes items from the library and filesystem.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional ids: string[]
    - Optional options: any
    Returns AxiosPromise<void>
- getAncestors:function
  - getAncestors(itemId: string, userId?: string, options?: any): AxiosPromise<BaseItemDto[]>
  - - Defined in generated-client/api/library-api.ts:1507
    summary
    Gets all parents of an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional userId: string
    - Optional options: any
    Returns AxiosPromise<BaseItemDto[]>
- getCriticReviews:function
  - getCriticReviews(itemId: string, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/library-api.ts:1518
    summary
    Gets critic review for an item.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getDownload:function
  - getDownload(itemId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/library-api.ts:1528
    summary
    Downloads item media.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional options: any
    Returns AxiosPromise<any>
- getFile:function
  - getFile(itemId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/library-api.ts:1538
    summary
    Get the original file of an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional options: any
    Returns AxiosPromise<any>
- getItemCounts:function
  - getItemCounts(userId?: string, isFavorite?: boolean, options?: any): AxiosPromise<ItemCounts>
  - - Defined in generated-client/api/library-api.ts:1549
    summary
    Get item counts.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional isFavorite: boolean
    - Optional options: any
    Returns AxiosPromise<ItemCounts>
- getLibraryOptionsInfo:function
  - getLibraryOptionsInfo(libraryContentType?: string, isNewLibrary?: boolean, options?: any): AxiosPromise<LibraryOptionsResultDto>
  - - Defined in generated-client/api/library-api.ts:1560
    summary
    Gets the library options info.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional libraryContentType: string
    - Optional isNewLibrary: boolean
    - Optional options: any
    Returns AxiosPromise<LibraryOptionsResultDto>
- getMediaFolders:function
  - getMediaFolders(isHidden?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/library-api.ts:1570
    summary
    Gets all user media folders.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional isHidden: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getPhysicalPaths:function
  - getPhysicalPaths(options?: any): AxiosPromise<string[]>
  - - Defined in generated-client/api/library-api.ts:1579
    summary
    Gets a list of physical paths from virtual folders.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<string[]>
- getSimilarAlbums:function
  - getSimilarAlbums(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/library-api.ts:1593
    summary
    Gets similar items.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional excludeArtistIds: string[]
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getSimilarArtists:function
  - getSimilarArtists(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/library-api.ts:1607
    summary
    Gets similar items.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional excludeArtistIds: string[]
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getSimilarItems:function
  - getSimilarItems(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/library-api.ts:1621
    summary
    Gets similar items.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional excludeArtistIds: string[]
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getSimilarMovies:function
  - getSimilarMovies(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/library-api.ts:1635
    summary
    Gets similar items.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional excludeArtistIds: string[]
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getSimilarShows:function
  - getSimilarShows(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/library-api.ts:1649
    summary
    Gets similar items.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional excludeArtistIds: string[]
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getSimilarTrailers:function
  - getSimilarTrailers(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/library-api.ts:1663
    summary
    Gets similar items.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional excludeArtistIds: string[]
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getThemeMedia:function
  - getThemeMedia(itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): AxiosPromise<AllThemeMediaResult>
  - - Defined in generated-client/api/library-api.ts:1675
    summary
    Get theme songs and videos for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional userId: string
    - Optional inheritFromParent: boolean
    - Optional options: any
    Returns AxiosPromise<AllThemeMediaResult>
- getThemeSongs:function
  - getThemeSongs(itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): AxiosPromise<ThemeMediaResult>
  - - Defined in generated-client/api/library-api.ts:1687
    summary
    Get theme songs for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional userId: string
    - Optional inheritFromParent: boolean
    - Optional options: any
    Returns AxiosPromise<ThemeMediaResult>
- getThemeVideos:function
  - getThemeVideos(itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): AxiosPromise<ThemeMediaResult>
  - - Defined in generated-client/api/library-api.ts:1699
    summary
    Get theme videos for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional userId: string
    - Optional inheritFromParent: boolean
    - Optional options: any
    Returns AxiosPromise<ThemeMediaResult>
- postAddedMovies:function
  - postAddedMovies(tmdbId?: string, imdbId?: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/library-api.ts:1710
    summary
    Reports that new movies have been added by an external source.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional tmdbId: string
    - Optional imdbId: string
    - Optional options: any
    Returns AxiosPromise<void>
- postAddedSeries:function
  - postAddedSeries(tvdbId?: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/library-api.ts:1720
    summary
    Reports that new episodes of a series have been added by an external source.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional tvdbId: string
    - Optional options: any
    Returns AxiosPromise<void>
- postUpdatedMedia:function
  - postUpdatedMedia(mediaUpdateInfoDto: MediaUpdateInfoDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/library-api.ts:1730
    summary
    Reports that new movies have been added by an external source.
    
    throws
    {RequiredError}
    
    Parameters
    - mediaUpdateInfoDto: MediaUpdateInfoDto
      The update paths.
    - Optional options: any
    Returns AxiosPromise<void>
- postUpdatedMovies:function
  - postUpdatedMovies(tmdbId?: string, imdbId?: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/library-api.ts:1741
    summary
    Reports that new movies have been added by an external source.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional tmdbId: string
    - Optional imdbId: string
    - Optional options: any
    Returns AxiosPromise<void>
- postUpdatedSeries:function
  - postUpdatedSeries(tvdbId?: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/library-api.ts:1751
    summary
    Reports that new episodes of a series have been added by an external source.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional tvdbId: string
    - Optional options: any
    Returns AxiosPromise<void>
- refreshLibrary:function
  - refreshLibrary(options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/library-api.ts:1760
    summary
    Starts a library scan.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<void>

Const LibraryApiFp

LibraryApiFp(configuration?: Configuration): { deleteItem: any; deleteItems: any; getAncestors: any; getCriticReviews: any; getDownload: any; getFile: any; getItemCounts: any; getLibraryOptionsInfo: any; getMediaFolders: any; getPhysicalPaths: any; getSimilarAlbums: any; getSimilarArtists: any; getSimilarItems: any; getSimilarMovies: any; getSimilarShows: any; getSimilarTrailers: any; getThemeMedia: any; getThemeSongs: any; getThemeVideos: any; postAddedMovies: any; postAddedSeries: any; postUpdatedMedia: any; postUpdatedMovies: any; postUpdatedSeries: any; refreshLibrary: any }

- Defined in generated-client/api/library-api.ts:1157
LibraryApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { deleteItem: any; deleteItems: any; getAncestors: any; getCriticReviews: any; getDownload: any; getFile: any; getItemCounts: any; getLibraryOptionsInfo: any; getMediaFolders: any; getPhysicalPaths: any; getSimilarAlbums: any; getSimilarArtists: any; getSimilarItems: any; getSimilarMovies: any; getSimilarShows: any; getSimilarTrailers: any; getThemeMedia: any; getThemeSongs: any; getThemeVideos: any; postAddedMovies: any; postAddedSeries: any; postUpdatedMedia: any; postUpdatedMovies: any; postUpdatedSeries: any; refreshLibrary: any }
- deleteItem:function
  - deleteItem(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/library-api.ts:1167
    summary
    Deletes an item from the library and filesystem.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- deleteItems:function
  - deleteItems(ids?: string[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/library-api.ts:1178
    summary
    Deletes items from the library and filesystem.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional ids: string[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getAncestors:function
  - getAncestors(itemId: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>>
  - - Defined in generated-client/api/library-api.ts:1190
    summary
    Gets all parents of an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>>
- getCriticReviews:function
  - getCriticReviews(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/library-api.ts:1202
    summary
    Gets critic review for an item.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getDownload:function
  - getDownload(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/library-api.ts:1213
    summary
    Downloads item media.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getFile:function
  - getFile(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/library-api.ts:1224
    summary
    Get the original file of an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getItemCounts:function
  - getItemCounts(userId?: string, isFavorite?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemCounts>>
  - - Defined in generated-client/api/library-api.ts:1236
    summary
    Get item counts.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional isFavorite: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemCounts>>
- getLibraryOptionsInfo:function
  - getLibraryOptionsInfo(libraryContentType?: string, isNewLibrary?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LibraryOptionsResultDto>>
  - - Defined in generated-client/api/library-api.ts:1248
    summary
    Gets the library options info.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional libraryContentType: string
    - Optional isNewLibrary: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LibraryOptionsResultDto>>
- getMediaFolders:function
  - getMediaFolders(isHidden?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/library-api.ts:1259
    summary
    Gets all user media folders.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional isHidden: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getPhysicalPaths:function
  - getPhysicalPaths(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>>
  - - Defined in generated-client/api/library-api.ts:1269
    summary
    Gets a list of physical paths from virtual folders.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>>
- getSimilarAlbums:function
  - getSimilarAlbums(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/library-api.ts:1284
    summary
    Gets similar items.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional excludeArtistIds: string[]
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getSimilarArtists:function
  - getSimilarArtists(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/library-api.ts:1299
    summary
    Gets similar items.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional excludeArtistIds: string[]
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getSimilarItems:function
  - getSimilarItems(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/library-api.ts:1314
    summary
    Gets similar items.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional excludeArtistIds: string[]
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getSimilarMovies:function
  - getSimilarMovies(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/library-api.ts:1329
    summary
    Gets similar items.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional excludeArtistIds: string[]
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getSimilarShows:function
  - getSimilarShows(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/library-api.ts:1344
    summary
    Gets similar items.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional excludeArtistIds: string[]
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getSimilarTrailers:function
  - getSimilarTrailers(itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/library-api.ts:1359
    summary
    Gets similar items.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional excludeArtistIds: string[]
    - Optional userId: string
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getThemeMedia:function
  - getThemeMedia(itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AllThemeMediaResult>>
  - - Defined in generated-client/api/library-api.ts:1372
    summary
    Get theme songs and videos for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional userId: string
    - Optional inheritFromParent: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AllThemeMediaResult>>
- getThemeSongs:function
  - getThemeSongs(itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ThemeMediaResult>>
  - - Defined in generated-client/api/library-api.ts:1385
    summary
    Get theme songs for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional userId: string
    - Optional inheritFromParent: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ThemeMediaResult>>
- getThemeVideos:function
  - getThemeVideos(itemId: string, userId?: string, inheritFromParent?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ThemeMediaResult>>
  - - Defined in generated-client/api/library-api.ts:1398
    summary
    Get theme videos for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional userId: string
    - Optional inheritFromParent: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ThemeMediaResult>>
- postAddedMovies:function
  - postAddedMovies(tmdbId?: string, imdbId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/library-api.ts:1410
    summary
    Reports that new movies have been added by an external source.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional tmdbId: string
    - Optional imdbId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- postAddedSeries:function
  - postAddedSeries(tvdbId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/library-api.ts:1421
    summary
    Reports that new episodes of a series have been added by an external source.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional tvdbId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- postUpdatedMedia:function
  - postUpdatedMedia(mediaUpdateInfoDto: MediaUpdateInfoDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/library-api.ts:1432
    summary
    Reports that new movies have been added by an external source.
    
    throws
    {RequiredError}
    
    Parameters
    - mediaUpdateInfoDto: MediaUpdateInfoDto
      The update paths.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- postUpdatedMovies:function
  - postUpdatedMovies(tmdbId?: string, imdbId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/library-api.ts:1444
    summary
    Reports that new movies have been added by an external source.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional tmdbId: string
    - Optional imdbId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- postUpdatedSeries:function
  - postUpdatedSeries(tvdbId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/library-api.ts:1455
    summary
    Reports that new episodes of a series have been added by an external source.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional tvdbId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- refreshLibrary:function
  - refreshLibrary(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/library-api.ts:1465
    summary
    Starts a library scan.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const LibraryStructureApiAxiosParamCreator

LibraryStructureApiAxiosParamCreator(configuration?: Configuration): { addMediaPath: (mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>; addVirtualFolder: (name?: string, collectionType?: CollectionTypeOptions, paths?: string[], refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options?: any) => Promise<RequestArgs>; getVirtualFolders: (options?: any) => Promise<RequestArgs>; removeMediaPath: (name?: string, path?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>; removeVirtualFolder: (name?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>; renameVirtualFolder: (name?: string, newName?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>; updateLibraryOptions: (updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: any) => Promise<RequestArgs>; updateMediaPath: (updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/library-structure-api.ts:41
LibraryStructureApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { addMediaPath: (mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>; addVirtualFolder: (name?: string, collectionType?: CollectionTypeOptions, paths?: string[], refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options?: any) => Promise<RequestArgs>; getVirtualFolders: (options?: any) => Promise<RequestArgs>; removeMediaPath: (name?: string, path?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>; removeVirtualFolder: (name?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>; renameVirtualFolder: (name?: string, newName?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>; updateLibraryOptions: (updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: any) => Promise<RequestArgs>; updateMediaPath: (updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: any) => Promise<RequestArgs> }
- addMediaPath: (mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>
  - - (mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Add a media path to a library.
      
      throws
      {RequiredError}
      
      Parameters
      - mediaPathDto: MediaPathDto
        The media path dto.
      - Optional refreshLibrary: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- addVirtualFolder: (name?: string, collectionType?: CollectionTypeOptions, paths?: string[], refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options?: any) => Promise<RequestArgs>
  - - (name?: string, collectionType?: CollectionTypeOptions, paths?: string[], refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options?: any): Promise<RequestArgs>
    - summary
      Adds a virtual folder.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional name: string
      - Optional collectionType: CollectionTypeOptions
      - Optional paths: string[]
      - Optional refreshLibrary: boolean
      - Optional addVirtualFolderDto: AddVirtualFolderDto
      - options: any = {}
      Returns Promise<RequestArgs>
- getVirtualFolders: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets all virtual folders.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- removeMediaPath: (name?: string, path?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>
  - - (name?: string, path?: string, refreshLibrary?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Remove a media path.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional name: string
      - Optional path: string
      - Optional refreshLibrary: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- removeVirtualFolder: (name?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>
  - - (name?: string, refreshLibrary?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Removes a virtual folder.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional name: string
      - Optional refreshLibrary: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- renameVirtualFolder: (name?: string, newName?: string, refreshLibrary?: boolean, options?: any) => Promise<RequestArgs>
  - - (name?: string, newName?: string, refreshLibrary?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Renames a virtual folder.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional name: string
      - Optional newName: string
      - Optional refreshLibrary: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- updateLibraryOptions: (updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: any) => Promise<RequestArgs>
  - - (updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: any): Promise<RequestArgs>
    - summary
      Update library options.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional updateLibraryOptionsDto: UpdateLibraryOptionsDto
      - options: any = {}
      Returns Promise<RequestArgs>
- updateMediaPath: (updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: any) => Promise<RequestArgs>
  - - (updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Updates a media path.
      
      throws
      {RequiredError}
      
      Parameters
      - updateMediaPathRequestDto: UpdateMediaPathRequestDto
        The name of the library and path infos.
      - options: any = {}
      Returns Promise<RequestArgs>

Const LibraryStructureApiFactory

LibraryStructureApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { addMediaPath: any; addVirtualFolder: any; getVirtualFolders: any; removeMediaPath: any; removeVirtualFolder: any; renameVirtualFolder: any; updateLibraryOptions: any; updateMediaPath: any }

- Defined in generated-client/api/library-structure-api.ts:506
LibraryStructureApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { addMediaPath: any; addVirtualFolder: any; getVirtualFolders: any; removeMediaPath: any; removeVirtualFolder: any; renameVirtualFolder: any; updateLibraryOptions: any; updateMediaPath: any }
- addMediaPath:function
  - addMediaPath(mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/library-structure-api.ts:517
    summary
    Add a media path to a library.
    
    throws
    {RequiredError}
    
    Parameters
    - mediaPathDto: MediaPathDto
      The media path dto.
    - Optional refreshLibrary: boolean
    - Optional options: any
    Returns AxiosPromise<void>
- addVirtualFolder:function
  - addVirtualFolder(name?: string, collectionType?: CollectionTypeOptions, paths?: string[], refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/library-structure-api.ts:531
    summary
    Adds a virtual folder.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional name: string
    - Optional collectionType: CollectionTypeOptions
    - Optional paths: string[]
    - Optional refreshLibrary: boolean
    - Optional addVirtualFolderDto: AddVirtualFolderDto
    - Optional options: any
    Returns AxiosPromise<void>
- getVirtualFolders:function
  - getVirtualFolders(options?: any): AxiosPromise<VirtualFolderInfo[]>
  - - Defined in generated-client/api/library-structure-api.ts:540
    summary
    Gets all virtual folders.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<VirtualFolderInfo[]>
- removeMediaPath:function
  - removeMediaPath(name?: string, path?: string, refreshLibrary?: boolean, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/library-structure-api.ts:552
    summary
    Remove a media path.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional name: string
    - Optional path: string
    - Optional refreshLibrary: boolean
    - Optional options: any
    Returns AxiosPromise<void>
- removeVirtualFolder:function
  - removeVirtualFolder(name?: string, refreshLibrary?: boolean, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/library-structure-api.ts:563
    summary
    Removes a virtual folder.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional name: string
    - Optional refreshLibrary: boolean
    - Optional options: any
    Returns AxiosPromise<void>
- renameVirtualFolder:function
  - renameVirtualFolder(name?: string, newName?: string, refreshLibrary?: boolean, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/library-structure-api.ts:575
    summary
    Renames a virtual folder.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional name: string
    - Optional newName: string
    - Optional refreshLibrary: boolean
    - Optional options: any
    Returns AxiosPromise<void>
- updateLibraryOptions:function
  - updateLibraryOptions(updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/library-structure-api.ts:585
    summary
    Update library options.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional updateLibraryOptionsDto: UpdateLibraryOptionsDto
    - Optional options: any
    Returns AxiosPromise<void>
- updateMediaPath:function
  - updateMediaPath(updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/library-structure-api.ts:595
    summary
    Updates a media path.
    
    throws
    {RequiredError}
    
    Parameters
    - updateMediaPathRequestDto: UpdateMediaPathRequestDto
      The name of the library and path infos.
    - Optional options: any
    Returns AxiosPromise<void>

Const LibraryStructureApiFp

LibraryStructureApiFp(configuration?: Configuration): { addMediaPath: any; addVirtualFolder: any; getVirtualFolders: any; removeMediaPath: any; removeVirtualFolder: any; renameVirtualFolder: any; updateLibraryOptions: any; updateMediaPath: any }

- Defined in generated-client/api/library-structure-api.ts:399
LibraryStructureApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { addMediaPath: any; addVirtualFolder: any; getVirtualFolders: any; removeMediaPath: any; removeVirtualFolder: any; renameVirtualFolder: any; updateLibraryOptions: any; updateMediaPath: any }
- addMediaPath:function
  - addMediaPath(mediaPathDto: MediaPathDto, refreshLibrary?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/library-structure-api.ts:410
    summary
    Add a media path to a library.
    
    throws
    {RequiredError}
    
    Parameters
    - mediaPathDto: MediaPathDto
      The media path dto.
    - Optional refreshLibrary: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- addVirtualFolder:function
  - addVirtualFolder(name?: string, collectionType?: CollectionTypeOptions, paths?: string[], refreshLibrary?: boolean, addVirtualFolderDto?: AddVirtualFolderDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/library-structure-api.ts:425
    summary
    Adds a virtual folder.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional name: string
    - Optional collectionType: CollectionTypeOptions
    - Optional paths: string[]
    - Optional refreshLibrary: boolean
    - Optional addVirtualFolderDto: AddVirtualFolderDto
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getVirtualFolders:function
  - getVirtualFolders(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VirtualFolderInfo[]>>
  - - Defined in generated-client/api/library-structure-api.ts:435
    summary
    Gets all virtual folders.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VirtualFolderInfo[]>>
- removeMediaPath:function
  - removeMediaPath(name?: string, path?: string, refreshLibrary?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/library-structure-api.ts:448
    summary
    Remove a media path.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional name: string
    - Optional path: string
    - Optional refreshLibrary: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- removeVirtualFolder:function
  - removeVirtualFolder(name?: string, refreshLibrary?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/library-structure-api.ts:460
    summary
    Removes a virtual folder.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional name: string
    - Optional refreshLibrary: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- renameVirtualFolder:function
  - renameVirtualFolder(name?: string, newName?: string, refreshLibrary?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/library-structure-api.ts:473
    summary
    Renames a virtual folder.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional name: string
    - Optional newName: string
    - Optional refreshLibrary: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- updateLibraryOptions:function
  - updateLibraryOptions(updateLibraryOptionsDto?: UpdateLibraryOptionsDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/library-structure-api.ts:484
    summary
    Update library options.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional updateLibraryOptionsDto: UpdateLibraryOptionsDto
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- updateMediaPath:function
  - updateMediaPath(updateMediaPathRequestDto: UpdateMediaPathRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/library-structure-api.ts:495
    summary
    Updates a media path.
    
    throws
    {RequiredError}
    
    Parameters
    - updateMediaPathRequestDto: UpdateMediaPathRequestDto
      The name of the library and path infos.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const LiveTvApiAxiosParamCreator

LiveTvApiAxiosParamCreator(configuration?: Configuration): { addListingProvider: (pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options?: any) => Promise<RequestArgs>; addTunerHost: (tunerHostInfo?: TunerHostInfo, options?: any) => Promise<RequestArgs>; cancelSeriesTimer: (timerId: string, options?: any) => Promise<RequestArgs>; cancelTimer: (timerId: string, options?: any) => Promise<RequestArgs>; createSeriesTimer: (seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any) => Promise<RequestArgs>; createTimer: (timerInfoDto?: TimerInfoDto, options?: any) => Promise<RequestArgs>; deleteListingProvider: (id?: string, options?: any) => Promise<RequestArgs>; deleteRecording: (recordingId: string, options?: any) => Promise<RequestArgs>; deleteTunerHost: (id?: string, options?: any) => Promise<RequestArgs>; discoverTuners: (newDevicesOnly?: boolean, options?: any) => Promise<RequestArgs>; discvoverTuners: (newDevicesOnly?: boolean, options?: any) => Promise<RequestArgs>; getChannel: (channelId: string, userId?: string, options?: any) => Promise<RequestArgs>; getChannelMappingOptions: (providerId?: string, options?: any) => Promise<RequestArgs>; getDefaultListingProvider: (options?: any) => Promise<RequestArgs>; getDefaultTimer: (programId?: string, options?: any) => Promise<RequestArgs>; getGuideInfo: (options?: any) => Promise<RequestArgs>; getLineups: (id?: string, type?: string, location?: string, country?: string, options?: any) => Promise<RequestArgs>; getLiveRecordingFile: (recordingId: string, options?: any) => Promise<RequestArgs>; getLiveStreamFile: (streamId: string, container: string, options?: any) => Promise<RequestArgs>; getLiveTvChannels: (type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, sortBy?: string[], sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: any) => Promise<RequestArgs>; getLiveTvInfo: (options?: any) => Promise<RequestArgs>; getLiveTvPrograms: (channelIds?: string[], userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: string[], sortOrder?: SortOrder[], genres?: string[], genreIds?: string[], enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: ItemFields[], enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getProgram: (programId: string, userId?: string, options?: any) => Promise<RequestArgs>; getPrograms: (getProgramsDto?: GetProgramsDto, options?: any) => Promise<RequestArgs>; getRecommendedPrograms: (userId?: string, limit?: number, isAiring?: boolean, hasAired?: boolean, isSeries?: boolean, isMovie?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], genreIds?: string[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getRecording: (recordingId: string, userId?: string, options?: any) => Promise<RequestArgs>; getRecordingFolders: (userId?: string, options?: any) => Promise<RequestArgs>; getRecordingGroup: (groupId: string, options?: any) => Promise<RequestArgs>; getRecordingGroups: (userId?: string, options?: any) => Promise<RequestArgs>; getRecordings: (channelId?: string, userId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, isMovie?: boolean, isSeries?: boolean, isKids?: boolean, isSports?: boolean, isNews?: boolean, isLibraryItem?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getRecordingsSeries: (channelId?: string, userId?: string, groupId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getSchedulesDirectCountries: (options?: any) => Promise<RequestArgs>; getSeriesTimer: (timerId: string, options?: any) => Promise<RequestArgs>; getSeriesTimers: (sortBy?: string, sortOrder?: SortOrder, options?: any) => Promise<RequestArgs>; getTimer: (timerId: string, options?: any) => Promise<RequestArgs>; getTimers: (channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options?: any) => Promise<RequestArgs>; getTunerHostTypes: (options?: any) => Promise<RequestArgs>; resetTuner: (tunerId: string, options?: any) => Promise<RequestArgs>; setChannelMapping: (setChannelMappingDto: SetChannelMappingDto, options?: any) => Promise<RequestArgs>; updateSeriesTimer: (timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any) => Promise<RequestArgs>; updateTimer: (timerId: string, timerInfoDto?: TimerInfoDto, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/live-tv-api.ts:69
LiveTvApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { addListingProvider: (pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options?: any) => Promise<RequestArgs>; addTunerHost: (tunerHostInfo?: TunerHostInfo, options?: any) => Promise<RequestArgs>; cancelSeriesTimer: (timerId: string, options?: any) => Promise<RequestArgs>; cancelTimer: (timerId: string, options?: any) => Promise<RequestArgs>; createSeriesTimer: (seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any) => Promise<RequestArgs>; createTimer: (timerInfoDto?: TimerInfoDto, options?: any) => Promise<RequestArgs>; deleteListingProvider: (id?: string, options?: any) => Promise<RequestArgs>; deleteRecording: (recordingId: string, options?: any) => Promise<RequestArgs>; deleteTunerHost: (id?: string, options?: any) => Promise<RequestArgs>; discoverTuners: (newDevicesOnly?: boolean, options?: any) => Promise<RequestArgs>; discvoverTuners: (newDevicesOnly?: boolean, options?: any) => Promise<RequestArgs>; getChannel: (channelId: string, userId?: string, options?: any) => Promise<RequestArgs>; getChannelMappingOptions: (providerId?: string, options?: any) => Promise<RequestArgs>; getDefaultListingProvider: (options?: any) => Promise<RequestArgs>; getDefaultTimer: (programId?: string, options?: any) => Promise<RequestArgs>; getGuideInfo: (options?: any) => Promise<RequestArgs>; getLineups: (id?: string, type?: string, location?: string, country?: string, options?: any) => Promise<RequestArgs>; getLiveRecordingFile: (recordingId: string, options?: any) => Promise<RequestArgs>; getLiveStreamFile: (streamId: string, container: string, options?: any) => Promise<RequestArgs>; getLiveTvChannels: (type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, sortBy?: string[], sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: any) => Promise<RequestArgs>; getLiveTvInfo: (options?: any) => Promise<RequestArgs>; getLiveTvPrograms: (channelIds?: string[], userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: string[], sortOrder?: SortOrder[], genres?: string[], genreIds?: string[], enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: ItemFields[], enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getProgram: (programId: string, userId?: string, options?: any) => Promise<RequestArgs>; getPrograms: (getProgramsDto?: GetProgramsDto, options?: any) => Promise<RequestArgs>; getRecommendedPrograms: (userId?: string, limit?: number, isAiring?: boolean, hasAired?: boolean, isSeries?: boolean, isMovie?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], genreIds?: string[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getRecording: (recordingId: string, userId?: string, options?: any) => Promise<RequestArgs>; getRecordingFolders: (userId?: string, options?: any) => Promise<RequestArgs>; getRecordingGroup: (groupId: string, options?: any) => Promise<RequestArgs>; getRecordingGroups: (userId?: string, options?: any) => Promise<RequestArgs>; getRecordings: (channelId?: string, userId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, isMovie?: boolean, isSeries?: boolean, isKids?: boolean, isSports?: boolean, isNews?: boolean, isLibraryItem?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getRecordingsSeries: (channelId?: string, userId?: string, groupId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>; getSchedulesDirectCountries: (options?: any) => Promise<RequestArgs>; getSeriesTimer: (timerId: string, options?: any) => Promise<RequestArgs>; getSeriesTimers: (sortBy?: string, sortOrder?: SortOrder, options?: any) => Promise<RequestArgs>; getTimer: (timerId: string, options?: any) => Promise<RequestArgs>; getTimers: (channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options?: any) => Promise<RequestArgs>; getTunerHostTypes: (options?: any) => Promise<RequestArgs>; resetTuner: (tunerId: string, options?: any) => Promise<RequestArgs>; setChannelMapping: (setChannelMappingDto: SetChannelMappingDto, options?: any) => Promise<RequestArgs>; updateSeriesTimer: (timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any) => Promise<RequestArgs>; updateTimer: (timerId: string, timerInfoDto?: TimerInfoDto, options?: any) => Promise<RequestArgs> }
- addListingProvider: (pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options?: any) => Promise<RequestArgs>
  - - (pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options?: any): Promise<RequestArgs>
    - summary
      Adds a listings provider.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional pw: string
      - Optional validateListings: boolean
      - Optional validateLogin: boolean
      - Optional listingsProviderInfo: ListingsProviderInfo
      - options: any = {}
      Returns Promise<RequestArgs>
- addTunerHost: (tunerHostInfo?: TunerHostInfo, options?: any) => Promise<RequestArgs>
  - - (tunerHostInfo?: TunerHostInfo, options?: any): Promise<RequestArgs>
    - summary
      Adds a tuner host.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional tunerHostInfo: TunerHostInfo
      - options: any = {}
      Returns Promise<RequestArgs>
- cancelSeriesTimer: (timerId: string, options?: any) => Promise<RequestArgs>
  - - (timerId: string, options?: any): Promise<RequestArgs>
    - summary
      Cancels a live tv series timer.
      
      throws
      {RequiredError}
      
      Parameters
      - timerId: string
        Timer id.
      - options: any = {}
      Returns Promise<RequestArgs>
- cancelTimer: (timerId: string, options?: any) => Promise<RequestArgs>
  - - (timerId: string, options?: any): Promise<RequestArgs>
    - summary
      Cancels a live tv timer.
      
      throws
      {RequiredError}
      
      Parameters
      - timerId: string
        Timer id.
      - options: any = {}
      Returns Promise<RequestArgs>
- createSeriesTimer: (seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any) => Promise<RequestArgs>
  - - (seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any): Promise<RequestArgs>
    - summary
      Creates a live tv series timer.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional seriesTimerInfoDto: SeriesTimerInfoDto
      - options: any = {}
      Returns Promise<RequestArgs>
- createTimer: (timerInfoDto?: TimerInfoDto, options?: any) => Promise<RequestArgs>
  - - (timerInfoDto?: TimerInfoDto, options?: any): Promise<RequestArgs>
    - summary
      Creates a live tv timer.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional timerInfoDto: TimerInfoDto
      - options: any = {}
      Returns Promise<RequestArgs>
- deleteListingProvider: (id?: string, options?: any) => Promise<RequestArgs>
  - - (id?: string, options?: any): Promise<RequestArgs>
    - summary
      Delete listing provider.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional id: string
      - options: any = {}
      Returns Promise<RequestArgs>
- deleteRecording: (recordingId: string, options?: any) => Promise<RequestArgs>
  - - (recordingId: string, options?: any): Promise<RequestArgs>
    - summary
      Deletes a live tv recording.
      
      throws
      {RequiredError}
      
      Parameters
      - recordingId: string
        Recording id.
      - options: any = {}
      Returns Promise<RequestArgs>
- deleteTunerHost: (id?: string, options?: any) => Promise<RequestArgs>
  - - (id?: string, options?: any): Promise<RequestArgs>
    - summary
      Deletes a tuner host.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional id: string
      - options: any = {}
      Returns Promise<RequestArgs>
- discoverTuners: (newDevicesOnly?: boolean, options?: any) => Promise<RequestArgs>
  - - (newDevicesOnly?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Discover tuners.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional newDevicesOnly: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- discvoverTuners: (newDevicesOnly?: boolean, options?: any) => Promise<RequestArgs>
  - - (newDevicesOnly?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Discover tuners.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional newDevicesOnly: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getChannel: (channelId: string, userId?: string, options?: any) => Promise<RequestArgs>
  - - (channelId: string, userId?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a live tv channel.
      
      throws
      {RequiredError}
      
      Parameters
      - channelId: string
        Channel id.
      - Optional userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getChannelMappingOptions: (providerId?: string, options?: any) => Promise<RequestArgs>
  - - (providerId?: string, options?: any): Promise<RequestArgs>
    - summary
      Get channel mapping options.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional providerId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getDefaultListingProvider: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets default listings provider info.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getDefaultTimer: (programId?: string, options?: any) => Promise<RequestArgs>
  - - (programId?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets the default values for a new timer.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional programId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getGuideInfo: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Get guid info.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getLineups: (id?: string, type?: string, location?: string, country?: string, options?: any) => Promise<RequestArgs>
  - - (id?: string, type?: string, location?: string, country?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets available lineups.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional id: string
      - Optional type: string
      - Optional location: string
      - Optional country: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getLiveRecordingFile: (recordingId: string, options?: any) => Promise<RequestArgs>
  - - (recordingId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a live tv recording stream.
      
      throws
      {RequiredError}
      
      Parameters
      - recordingId: string
        Recording id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getLiveStreamFile: (streamId: string, container: string, options?: any) => Promise<RequestArgs>
  - - (streamId: string, container: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a live tv channel stream.
      
      throws
      {RequiredError}
      
      Parameters
      - streamId: string
        Stream id.
      - container: string
        Container type.
      - options: any = {}
      Returns Promise<RequestArgs>
- getLiveTvChannels: (type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, sortBy?: string[], sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: any) => Promise<RequestArgs>
  - - (type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, sortBy?: string[], sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets available live tv channels.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional type: ChannelType
      - Optional userId: string
      - Optional startIndex: number
      - Optional isMovie: boolean
      - Optional isSeries: boolean
      - Optional isNews: boolean
      - Optional isKids: boolean
      - Optional isSports: boolean
      - Optional limit: number
      - Optional isFavorite: boolean
      - Optional isLiked: boolean
      - Optional isDisliked: boolean
      - Optional enableImages: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional fields: ItemFields[]
      - Optional enableUserData: boolean
      - Optional sortBy: string[]
      - Optional sortOrder: SortOrder
      - Optional enableFavoriteSorting: boolean
      - Optional addCurrentProgram: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getLiveTvInfo: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets available live tv services.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getLiveTvPrograms: (channelIds?: string[], userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: string[], sortOrder?: SortOrder[], genres?: string[], genreIds?: string[], enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: ItemFields[], enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
  - - (channelIds?: string[], userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: string[], sortOrder?: SortOrder[], genres?: string[], genreIds?: string[], enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: ItemFields[], enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets available live tv epgs.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional channelIds: string[]
      - Optional userId: string
      - Optional minStartDate: string
      - Optional hasAired: boolean
      - Optional isAiring: boolean
      - Optional maxStartDate: string
      - Optional minEndDate: string
      - Optional maxEndDate: string
      - Optional isMovie: boolean
      - Optional isSeries: boolean
      - Optional isNews: boolean
      - Optional isKids: boolean
      - Optional isSports: boolean
      - Optional startIndex: number
      - Optional limit: number
      - Optional sortBy: string[]
      - Optional sortOrder: SortOrder[]
      - Optional genres: string[]
      - Optional genreIds: string[]
      - Optional enableImages: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional enableUserData: boolean
      - Optional seriesTimerId: string
      - Optional librarySeriesId: string
      - Optional fields: ItemFields[]
      - Optional enableTotalRecordCount: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getProgram: (programId: string, userId?: string, options?: any) => Promise<RequestArgs>
  - - (programId: string, userId?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a live tv program.
      
      throws
      {RequiredError}
      
      Parameters
      - programId: string
        Program id.
      - Optional userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getPrograms: (getProgramsDto?: GetProgramsDto, options?: any) => Promise<RequestArgs>
  - - (getProgramsDto?: GetProgramsDto, options?: any): Promise<RequestArgs>
    - summary
      Gets available live tv epgs.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional getProgramsDto: GetProgramsDto
      - options: any = {}
      Returns Promise<RequestArgs>
- getRecommendedPrograms: (userId?: string, limit?: number, isAiring?: boolean, hasAired?: boolean, isSeries?: boolean, isMovie?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], genreIds?: string[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
  - - (userId?: string, limit?: number, isAiring?: boolean, hasAired?: boolean, isSeries?: boolean, isMovie?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], genreIds?: string[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets recommended live tv epgs.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional userId: string
      - Optional limit: number
      - Optional isAiring: boolean
      - Optional hasAired: boolean
      - Optional isSeries: boolean
      - Optional isMovie: boolean
      - Optional isNews: boolean
      - Optional isKids: boolean
      - Optional isSports: boolean
      - Optional enableImages: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional genreIds: string[]
      - Optional fields: ItemFields[]
      - Optional enableUserData: boolean
      - Optional enableTotalRecordCount: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getRecording: (recordingId: string, userId?: string, options?: any) => Promise<RequestArgs>
  - - (recordingId: string, userId?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a live tv recording.
      
      throws
      {RequiredError}
      
      Parameters
      - recordingId: string
        Recording id.
      - Optional userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getRecordingFolders: (userId?: string, options?: any) => Promise<RequestArgs>
  - - (userId?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets recording folders.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getRecordingGroup: (groupId: string, options?: any) => Promise<RequestArgs>
  - - (groupId: string, options?: any): Promise<RequestArgs>
    - summary
      Get recording group.
      
      deprecated
      throws
      {RequiredError}
      
      Parameters
      - groupId: string
        Group id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getRecordingGroups: (userId?: string, options?: any) => Promise<RequestArgs>
  - - (userId?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets live tv recording groups.
      
      deprecated
      throws
      {RequiredError}
      
      Parameters
      - Optional userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getRecordings: (channelId?: string, userId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, isMovie?: boolean, isSeries?: boolean, isKids?: boolean, isSports?: boolean, isNews?: boolean, isLibraryItem?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
  - - (channelId?: string, userId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, isMovie?: boolean, isSeries?: boolean, isKids?: boolean, isSports?: boolean, isNews?: boolean, isLibraryItem?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets live tv recordings.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional channelId: string
      - Optional userId: string
      - Optional startIndex: number
      - Optional limit: number
      - Optional status: RecordingStatus
      - Optional isInProgress: boolean
      - Optional seriesTimerId: string
      - Optional enableImages: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional fields: ItemFields[]
      - Optional enableUserData: boolean
      - Optional isMovie: boolean
      - Optional isSeries: boolean
      - Optional isKids: boolean
      - Optional isSports: boolean
      - Optional isNews: boolean
      - Optional isLibraryItem: boolean
      - Optional enableTotalRecordCount: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getRecordingsSeries: (channelId?: string, userId?: string, groupId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
  - - (channelId?: string, userId?: string, groupId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets live tv recording series.
      
      deprecated
      throws
      {RequiredError}
      
      Parameters
      - Optional channelId: string
      - Optional userId: string
      - Optional groupId: string
      - Optional startIndex: number
      - Optional limit: number
      - Optional status: RecordingStatus
      - Optional isInProgress: boolean
      - Optional seriesTimerId: string
      - Optional enableImages: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional fields: ItemFields[]
      - Optional enableUserData: boolean
      - Optional enableTotalRecordCount: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getSchedulesDirectCountries: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets available countries.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getSeriesTimer: (timerId: string, options?: any) => Promise<RequestArgs>
  - - (timerId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a live tv series timer.
      
      throws
      {RequiredError}
      
      Parameters
      - timerId: string
        Timer id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getSeriesTimers: (sortBy?: string, sortOrder?: SortOrder, options?: any) => Promise<RequestArgs>
  - - (sortBy?: string, sortOrder?: SortOrder, options?: any): Promise<RequestArgs>
    - summary
      Gets live tv series timers.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional sortBy: string
      - Optional sortOrder: SortOrder
      - options: any = {}
      Returns Promise<RequestArgs>
- getTimer: (timerId: string, options?: any) => Promise<RequestArgs>
  - - (timerId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a timer.
      
      throws
      {RequiredError}
      
      Parameters
      - timerId: string
        Timer id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getTimers: (channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options?: any) => Promise<RequestArgs>
  - - (channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets the live tv timers.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional channelId: string
      - Optional seriesTimerId: string
      - Optional isActive: boolean
      - Optional isScheduled: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getTunerHostTypes: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Get tuner host types.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- resetTuner: (tunerId: string, options?: any) => Promise<RequestArgs>
  - - (tunerId: string, options?: any): Promise<RequestArgs>
    - summary
      Resets a tv tuner.
      
      throws
      {RequiredError}
      
      Parameters
      - tunerId: string
        Tuner id.
      - options: any = {}
      Returns Promise<RequestArgs>
- setChannelMapping: (setChannelMappingDto: SetChannelMappingDto, options?: any) => Promise<RequestArgs>
  - - (setChannelMappingDto: SetChannelMappingDto, options?: any): Promise<RequestArgs>
    - summary
      Set channel mappings.
      
      throws
      {RequiredError}
      
      Parameters
      - setChannelMappingDto: SetChannelMappingDto
        The set channel mapping dto.
      - options: any = {}
      Returns Promise<RequestArgs>
- updateSeriesTimer: (timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any) => Promise<RequestArgs>
  - - (timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any): Promise<RequestArgs>
    - summary
      Updates a live tv series timer.
      
      throws
      {RequiredError}
      
      Parameters
      - timerId: string
        Timer id.
      - Optional seriesTimerInfoDto: SeriesTimerInfoDto
      - options: any = {}
      Returns Promise<RequestArgs>
- updateTimer: (timerId: string, timerInfoDto?: TimerInfoDto, options?: any) => Promise<RequestArgs>
  - - (timerId: string, timerInfoDto?: TimerInfoDto, options?: any): Promise<RequestArgs>
    - summary
      Updates a live tv timer.
      
      throws
      {RequiredError}
      
      Parameters
      - timerId: string
        Timer id.
      - Optional timerInfoDto: TimerInfoDto
      - options: any = {}
      Returns Promise<RequestArgs>

Const LiveTvApiFactory

LiveTvApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { addListingProvider: any; addTunerHost: any; cancelSeriesTimer: any; cancelTimer: any; createSeriesTimer: any; createTimer: any; deleteListingProvider: any; deleteRecording: any; deleteTunerHost: any; discoverTuners: any; discvoverTuners: any; getChannel: any; getChannelMappingOptions: any; getDefaultListingProvider: any; getDefaultTimer: any; getGuideInfo: any; getLineups: any; getLiveRecordingFile: any; getLiveStreamFile: any; getLiveTvChannels: any; getLiveTvInfo: any; getLiveTvPrograms: any; getProgram: any; getPrograms: any; getRecommendedPrograms: any; getRecording: any; getRecordingFolders: any; getRecordingGroup: any; getRecordingGroups: any; getRecordings: any; getRecordingsSeries: any; getSchedulesDirectCountries: any; getSeriesTimer: any; getSeriesTimers: any; getTimer: any; getTimers: any; getTunerHostTypes: any; resetTuner: any; setChannelMapping: any; updateSeriesTimer: any; updateTimer: any }

- Defined in generated-client/api/live-tv-api.ts:2702
LiveTvApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { addListingProvider: any; addTunerHost: any; cancelSeriesTimer: any; cancelTimer: any; createSeriesTimer: any; createTimer: any; deleteListingProvider: any; deleteRecording: any; deleteTunerHost: any; discoverTuners: any; discvoverTuners: any; getChannel: any; getChannelMappingOptions: any; getDefaultListingProvider: any; getDefaultTimer: any; getGuideInfo: any; getLineups: any; getLiveRecordingFile: any; getLiveStreamFile: any; getLiveTvChannels: any; getLiveTvInfo: any; getLiveTvPrograms: any; getProgram: any; getPrograms: any; getRecommendedPrograms: any; getRecording: any; getRecordingFolders: any; getRecordingGroup: any; getRecordingGroups: any; getRecordings: any; getRecordingsSeries: any; getSchedulesDirectCountries: any; getSeriesTimer: any; getSeriesTimers: any; getTimer: any; getTimers: any; getTunerHostTypes: any; resetTuner: any; setChannelMapping: any; updateSeriesTimer: any; updateTimer: any }
- addListingProvider:function
  - addListingProvider(pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options?: any): AxiosPromise<ListingsProviderInfo>
  - - Defined in generated-client/api/live-tv-api.ts:2715
    summary
    Adds a listings provider.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional pw: string
    - Optional validateListings: boolean
    - Optional validateLogin: boolean
    - Optional listingsProviderInfo: ListingsProviderInfo
    - Optional options: any
    Returns AxiosPromise<ListingsProviderInfo>
- addTunerHost:function
  - addTunerHost(tunerHostInfo?: TunerHostInfo, options?: any): AxiosPromise<TunerHostInfo>
  - - Defined in generated-client/api/live-tv-api.ts:2725
    summary
    Adds a tuner host.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional tunerHostInfo: TunerHostInfo
    - Optional options: any
    Returns AxiosPromise<TunerHostInfo>
- cancelSeriesTimer:function
  - cancelSeriesTimer(timerId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/live-tv-api.ts:2735
    summary
    Cancels a live tv series timer.
    
    throws
    {RequiredError}
    
    Parameters
    - timerId: string
      Timer id.
    - Optional options: any
    Returns AxiosPromise<void>
- cancelTimer:function
  - cancelTimer(timerId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/live-tv-api.ts:2745
    summary
    Cancels a live tv timer.
    
    throws
    {RequiredError}
    
    Parameters
    - timerId: string
      Timer id.
    - Optional options: any
    Returns AxiosPromise<void>
- createSeriesTimer:function
  - createSeriesTimer(seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/live-tv-api.ts:2755
    summary
    Creates a live tv series timer.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional seriesTimerInfoDto: SeriesTimerInfoDto
    - Optional options: any
    Returns AxiosPromise<void>
- createTimer:function
  - createTimer(timerInfoDto?: TimerInfoDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/live-tv-api.ts:2765
    summary
    Creates a live tv timer.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional timerInfoDto: TimerInfoDto
    - Optional options: any
    Returns AxiosPromise<void>
- deleteListingProvider:function
  - deleteListingProvider(id?: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/live-tv-api.ts:2775
    summary
    Delete listing provider.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional id: string
    - Optional options: any
    Returns AxiosPromise<void>
- deleteRecording:function
  - deleteRecording(recordingId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/live-tv-api.ts:2785
    summary
    Deletes a live tv recording.
    
    throws
    {RequiredError}
    
    Parameters
    - recordingId: string
      Recording id.
    - Optional options: any
    Returns AxiosPromise<void>
- deleteTunerHost:function
  - deleteTunerHost(id?: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/live-tv-api.ts:2795
    summary
    Deletes a tuner host.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional id: string
    - Optional options: any
    Returns AxiosPromise<void>
- discoverTuners:function
  - discoverTuners(newDevicesOnly?: boolean, options?: any): AxiosPromise<TunerHostInfo[]>
  - - Defined in generated-client/api/live-tv-api.ts:2805
    summary
    Discover tuners.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional newDevicesOnly: boolean
    - Optional options: any
    Returns AxiosPromise<TunerHostInfo[]>
- discvoverTuners:function
  - discvoverTuners(newDevicesOnly?: boolean, options?: any): AxiosPromise<TunerHostInfo[]>
  - - Defined in generated-client/api/live-tv-api.ts:2815
    summary
    Discover tuners.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional newDevicesOnly: boolean
    - Optional options: any
    Returns AxiosPromise<TunerHostInfo[]>
- getChannel:function
  - getChannel(channelId: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>
  - - Defined in generated-client/api/live-tv-api.ts:2826
    summary
    Gets a live tv channel.
    
    throws
    {RequiredError}
    
    Parameters
    - channelId: string
      Channel id.
    - Optional userId: string
    - Optional options: any
    Returns AxiosPromise<BaseItemDto>
- getChannelMappingOptions:function
  - getChannelMappingOptions(providerId?: string, options?: any): AxiosPromise<ChannelMappingOptionsDto>
  - - Defined in generated-client/api/live-tv-api.ts:2836
    summary
    Get channel mapping options.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional providerId: string
    - Optional options: any
    Returns AxiosPromise<ChannelMappingOptionsDto>
- getDefaultListingProvider:function
  - getDefaultListingProvider(options?: any): AxiosPromise<ListingsProviderInfo>
  - - Defined in generated-client/api/live-tv-api.ts:2845
    summary
    Gets default listings provider info.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<ListingsProviderInfo>
- getDefaultTimer:function
  - getDefaultTimer(programId?: string, options?: any): AxiosPromise<SeriesTimerInfoDto>
  - - Defined in generated-client/api/live-tv-api.ts:2855
    summary
    Gets the default values for a new timer.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional programId: string
    - Optional options: any
    Returns AxiosPromise<SeriesTimerInfoDto>
- getGuideInfo:function
  - getGuideInfo(options?: any): AxiosPromise<GuideInfo>
  - - Defined in generated-client/api/live-tv-api.ts:2864
    summary
    Get guid info.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<GuideInfo>
- getLineups:function
  - getLineups(id?: string, type?: string, location?: string, country?: string, options?: any): AxiosPromise<NameIdPair[]>
  - - Defined in generated-client/api/live-tv-api.ts:2877
    summary
    Gets available lineups.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional id: string
    - Optional type: string
    - Optional location: string
    - Optional country: string
    - Optional options: any
    Returns AxiosPromise<NameIdPair[]>
- getLiveRecordingFile:function
  - getLiveRecordingFile(recordingId: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/live-tv-api.ts:2887
    summary
    Gets a live tv recording stream.
    
    throws
    {RequiredError}
    
    Parameters
    - recordingId: string
      Recording id.
    - Optional options: any
    Returns AxiosPromise<any>
- getLiveStreamFile:function
  - getLiveStreamFile(streamId: string, container: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/live-tv-api.ts:2898
    summary
    Gets a live tv channel stream.
    
    throws
    {RequiredError}
    
    Parameters
    - streamId: string
      Stream id.
    - container: string
      Container type.
    - Optional options: any
    Returns AxiosPromise<any>
- getLiveTvChannels:function
  - getLiveTvChannels(type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, sortBy?: string[], sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/live-tv-api.ts:2928
    summary
    Gets available live tv channels.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional type: ChannelType
    - Optional userId: string
    - Optional startIndex: number
    - Optional isMovie: boolean
    - Optional isSeries: boolean
    - Optional isNews: boolean
    - Optional isKids: boolean
    - Optional isSports: boolean
    - Optional limit: number
    - Optional isFavorite: boolean
    - Optional isLiked: boolean
    - Optional isDisliked: boolean
    - Optional enableImages: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional fields: ItemFields[]
    - Optional enableUserData: boolean
    - Optional sortBy: string[]
    - Optional sortOrder: SortOrder
    - Optional enableFavoriteSorting: boolean
    - Optional addCurrentProgram: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getLiveTvInfo:function
  - getLiveTvInfo(options?: any): AxiosPromise<LiveTvInfo>
  - - Defined in generated-client/api/live-tv-api.ts:2937
    summary
    Gets available live tv services.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<LiveTvInfo>
- getLiveTvPrograms:function
  - getLiveTvPrograms(channelIds?: string[], userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: string[], sortOrder?: SortOrder[], genres?: string[], genreIds?: string[], enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: ItemFields[], enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/live-tv-api.ts:2973
    summary
    Gets available live tv epgs.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional channelIds: string[]
    - Optional userId: string
    - Optional minStartDate: string
    - Optional hasAired: boolean
    - Optional isAiring: boolean
    - Optional maxStartDate: string
    - Optional minEndDate: string
    - Optional maxEndDate: string
    - Optional isMovie: boolean
    - Optional isSeries: boolean
    - Optional isNews: boolean
    - Optional isKids: boolean
    - Optional isSports: boolean
    - Optional startIndex: number
    - Optional limit: number
    - Optional sortBy: string[]
    - Optional sortOrder: SortOrder[]
    - Optional genres: string[]
    - Optional genreIds: string[]
    - Optional enableImages: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional enableUserData: boolean
    - Optional seriesTimerId: string
    - Optional librarySeriesId: string
    - Optional fields: ItemFields[]
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getProgram:function
  - getProgram(programId: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>
  - - Defined in generated-client/api/live-tv-api.ts:2984
    summary
    Gets a live tv program.
    
    throws
    {RequiredError}
    
    Parameters
    - programId: string
      Program id.
    - Optional userId: string
    - Optional options: any
    Returns AxiosPromise<BaseItemDto>
- getPrograms:function
  - getPrograms(getProgramsDto?: GetProgramsDto, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/live-tv-api.ts:2994
    summary
    Gets available live tv epgs.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional getProgramsDto: GetProgramsDto
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getRecommendedPrograms:function
  - getRecommendedPrograms(userId?: string, limit?: number, isAiring?: boolean, hasAired?: boolean, isSeries?: boolean, isMovie?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], genreIds?: string[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/live-tv-api.ts:3019
    summary
    Gets recommended live tv epgs.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional limit: number
    - Optional isAiring: boolean
    - Optional hasAired: boolean
    - Optional isSeries: boolean
    - Optional isMovie: boolean
    - Optional isNews: boolean
    - Optional isKids: boolean
    - Optional isSports: boolean
    - Optional enableImages: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional genreIds: string[]
    - Optional fields: ItemFields[]
    - Optional enableUserData: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getRecording:function
  - getRecording(recordingId: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>
  - - Defined in generated-client/api/live-tv-api.ts:3030
    summary
    Gets a live tv recording.
    
    throws
    {RequiredError}
    
    Parameters
    - recordingId: string
      Recording id.
    - Optional userId: string
    - Optional options: any
    Returns AxiosPromise<BaseItemDto>
- getRecordingFolders:function
  - getRecordingFolders(userId?: string, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/live-tv-api.ts:3040
    summary
    Gets recording folders.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getRecordingGroup:function
  - getRecordingGroup(groupId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/live-tv-api.ts:3051
    summary
    Get recording group.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - groupId: string
      Group id.
    - Optional options: any
    Returns AxiosPromise<void>
- getRecordingGroups:function
  - getRecordingGroups(userId?: string, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/live-tv-api.ts:3062
    summary
    Gets live tv recording groups.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getRecordings:function
  - getRecordings(channelId?: string, userId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, isMovie?: boolean, isSeries?: boolean, isKids?: boolean, isSports?: boolean, isNews?: boolean, isLibraryItem?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/live-tv-api.ts:3090
    summary
    Gets live tv recordings.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional channelId: string
    - Optional userId: string
    - Optional startIndex: number
    - Optional limit: number
    - Optional status: RecordingStatus
    - Optional isInProgress: boolean
    - Optional seriesTimerId: string
    - Optional enableImages: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional fields: ItemFields[]
    - Optional enableUserData: boolean
    - Optional isMovie: boolean
    - Optional isSeries: boolean
    - Optional isKids: boolean
    - Optional isSports: boolean
    - Optional isNews: boolean
    - Optional isLibraryItem: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getRecordingsSeries:function
  - getRecordingsSeries(channelId?: string, userId?: string, groupId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/live-tv-api.ts:3114
    summary
    Gets live tv recording series.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - Optional channelId: string
    - Optional userId: string
    - Optional groupId: string
    - Optional startIndex: number
    - Optional limit: number
    - Optional status: RecordingStatus
    - Optional isInProgress: boolean
    - Optional seriesTimerId: string
    - Optional enableImages: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional fields: ItemFields[]
    - Optional enableUserData: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getSchedulesDirectCountries:function
  - getSchedulesDirectCountries(options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/live-tv-api.ts:3123
    summary
    Gets available countries.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<any>
- getSeriesTimer:function
  - getSeriesTimer(timerId: string, options?: any): AxiosPromise<SeriesTimerInfoDto>
  - - Defined in generated-client/api/live-tv-api.ts:3133
    summary
    Gets a live tv series timer.
    
    throws
    {RequiredError}
    
    Parameters
    - timerId: string
      Timer id.
    - Optional options: any
    Returns AxiosPromise<SeriesTimerInfoDto>
- getSeriesTimers:function
  - getSeriesTimers(sortBy?: string, sortOrder?: SortOrder, options?: any): AxiosPromise<SeriesTimerInfoDtoQueryResult>
  - - Defined in generated-client/api/live-tv-api.ts:3144
    summary
    Gets live tv series timers.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional sortBy: string
    - Optional sortOrder: SortOrder
    - Optional options: any
    Returns AxiosPromise<SeriesTimerInfoDtoQueryResult>
- getTimer:function
  - getTimer(timerId: string, options?: any): AxiosPromise<TimerInfoDto>
  - - Defined in generated-client/api/live-tv-api.ts:3154
    summary
    Gets a timer.
    
    throws
    {RequiredError}
    
    Parameters
    - timerId: string
      Timer id.
    - Optional options: any
    Returns AxiosPromise<TimerInfoDto>
- getTimers:function
  - getTimers(channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options?: any): AxiosPromise<TimerInfoDtoQueryResult>
  - - Defined in generated-client/api/live-tv-api.ts:3167
    summary
    Gets the live tv timers.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional channelId: string
    - Optional seriesTimerId: string
    - Optional isActive: boolean
    - Optional isScheduled: boolean
    - Optional options: any
    Returns AxiosPromise<TimerInfoDtoQueryResult>
- getTunerHostTypes:function
  - getTunerHostTypes(options?: any): AxiosPromise<NameIdPair[]>
  - - Defined in generated-client/api/live-tv-api.ts:3176
    summary
    Get tuner host types.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<NameIdPair[]>
- resetTuner:function
  - resetTuner(tunerId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/live-tv-api.ts:3186
    summary
    Resets a tv tuner.
    
    throws
    {RequiredError}
    
    Parameters
    - tunerId: string
      Tuner id.
    - Optional options: any
    Returns AxiosPromise<void>
- setChannelMapping:function
  - setChannelMapping(setChannelMappingDto: SetChannelMappingDto, options?: any): AxiosPromise<TunerChannelMapping>
  - - Defined in generated-client/api/live-tv-api.ts:3196
    summary
    Set channel mappings.
    
    throws
    {RequiredError}
    
    Parameters
    - setChannelMappingDto: SetChannelMappingDto
      The set channel mapping dto.
    - Optional options: any
    Returns AxiosPromise<TunerChannelMapping>
- updateSeriesTimer:function
  - updateSeriesTimer(timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/live-tv-api.ts:3207
    summary
    Updates a live tv series timer.
    
    throws
    {RequiredError}
    
    Parameters
    - timerId: string
      Timer id.
    - Optional seriesTimerInfoDto: SeriesTimerInfoDto
    - Optional options: any
    Returns AxiosPromise<void>
- updateTimer:function
  - updateTimer(timerId: string, timerInfoDto?: TimerInfoDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/live-tv-api.ts:3218
    summary
    Updates a live tv timer.
    
    throws
    {RequiredError}
    
    Parameters
    - timerId: string
      Timer id.
    - Optional timerInfoDto: TimerInfoDto
    - Optional options: any
    Returns AxiosPromise<void>

Const LiveTvApiFp

LiveTvApiFp(configuration?: Configuration): { addListingProvider: any; addTunerHost: any; cancelSeriesTimer: any; cancelTimer: any; createSeriesTimer: any; createTimer: any; deleteListingProvider: any; deleteRecording: any; deleteTunerHost: any; discoverTuners: any; discvoverTuners: any; getChannel: any; getChannelMappingOptions: any; getDefaultListingProvider: any; getDefaultTimer: any; getGuideInfo: any; getLineups: any; getLiveRecordingFile: any; getLiveStreamFile: any; getLiveTvChannels: any; getLiveTvInfo: any; getLiveTvPrograms: any; getProgram: any; getPrograms: any; getRecommendedPrograms: any; getRecording: any; getRecordingFolders: any; getRecordingGroup: any; getRecordingGroups: any; getRecordings: any; getRecordingsSeries: any; getSchedulesDirectCountries: any; getSeriesTimer: any; getSeriesTimers: any; getTimer: any; getTimers: any; getTunerHostTypes: any; resetTuner: any; setChannelMapping: any; updateSeriesTimer: any; updateTimer: any }

- Defined in generated-client/api/live-tv-api.ts:2135
LiveTvApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { addListingProvider: any; addTunerHost: any; cancelSeriesTimer: any; cancelTimer: any; createSeriesTimer: any; createTimer: any; deleteListingProvider: any; deleteRecording: any; deleteTunerHost: any; discoverTuners: any; discvoverTuners: any; getChannel: any; getChannelMappingOptions: any; getDefaultListingProvider: any; getDefaultTimer: any; getGuideInfo: any; getLineups: any; getLiveRecordingFile: any; getLiveStreamFile: any; getLiveTvChannels: any; getLiveTvInfo: any; getLiveTvPrograms: any; getProgram: any; getPrograms: any; getRecommendedPrograms: any; getRecording: any; getRecordingFolders: any; getRecordingGroup: any; getRecordingGroups: any; getRecordings: any; getRecordingsSeries: any; getSchedulesDirectCountries: any; getSeriesTimer: any; getSeriesTimers: any; getTimer: any; getTimers: any; getTunerHostTypes: any; resetTuner: any; setChannelMapping: any; updateSeriesTimer: any; updateTimer: any }
- addListingProvider:function
  - addListingProvider(pw?: string, validateListings?: boolean, validateLogin?: boolean, listingsProviderInfo?: ListingsProviderInfo, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>>
  - - Defined in generated-client/api/live-tv-api.ts:2148
    summary
    Adds a listings provider.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional pw: string
    - Optional validateListings: boolean
    - Optional validateLogin: boolean
    - Optional listingsProviderInfo: ListingsProviderInfo
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>>
- addTunerHost:function
  - addTunerHost(tunerHostInfo?: TunerHostInfo, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo>>
  - - Defined in generated-client/api/live-tv-api.ts:2159
    summary
    Adds a tuner host.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional tunerHostInfo: TunerHostInfo
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo>>
- cancelSeriesTimer:function
  - cancelSeriesTimer(timerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/live-tv-api.ts:2170
    summary
    Cancels a live tv series timer.
    
    throws
    {RequiredError}
    
    Parameters
    - timerId: string
      Timer id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- cancelTimer:function
  - cancelTimer(timerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/live-tv-api.ts:2181
    summary
    Cancels a live tv timer.
    
    throws
    {RequiredError}
    
    Parameters
    - timerId: string
      Timer id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- createSeriesTimer:function
  - createSeriesTimer(seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/live-tv-api.ts:2192
    summary
    Creates a live tv series timer.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional seriesTimerInfoDto: SeriesTimerInfoDto
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- createTimer:function
  - createTimer(timerInfoDto?: TimerInfoDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/live-tv-api.ts:2203
    summary
    Creates a live tv timer.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional timerInfoDto: TimerInfoDto
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- deleteListingProvider:function
  - deleteListingProvider(id?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/live-tv-api.ts:2214
    summary
    Delete listing provider.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional id: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- deleteRecording:function
  - deleteRecording(recordingId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/live-tv-api.ts:2225
    summary
    Deletes a live tv recording.
    
    throws
    {RequiredError}
    
    Parameters
    - recordingId: string
      Recording id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- deleteTunerHost:function
  - deleteTunerHost(id?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/live-tv-api.ts:2236
    summary
    Deletes a tuner host.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional id: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- discoverTuners:function
  - discoverTuners(newDevicesOnly?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>>
  - - Defined in generated-client/api/live-tv-api.ts:2247
    summary
    Discover tuners.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional newDevicesOnly: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>>
- discvoverTuners:function
  - discvoverTuners(newDevicesOnly?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>>
  - - Defined in generated-client/api/live-tv-api.ts:2258
    summary
    Discover tuners.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional newDevicesOnly: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerHostInfo[]>>
- getChannel:function
  - getChannel(channelId: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
  - - Defined in generated-client/api/live-tv-api.ts:2270
    summary
    Gets a live tv channel.
    
    throws
    {RequiredError}
    
    Parameters
    - channelId: string
      Channel id.
    - Optional userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
- getChannelMappingOptions:function
  - getChannelMappingOptions(providerId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelMappingOptionsDto>>
  - - Defined in generated-client/api/live-tv-api.ts:2281
    summary
    Get channel mapping options.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional providerId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChannelMappingOptionsDto>>
- getDefaultListingProvider:function
  - getDefaultListingProvider(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>>
  - - Defined in generated-client/api/live-tv-api.ts:2291
    summary
    Gets default listings provider info.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListingsProviderInfo>>
- getDefaultTimer:function
  - getDefaultTimer(programId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>>
  - - Defined in generated-client/api/live-tv-api.ts:2302
    summary
    Gets the default values for a new timer.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional programId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>>
- getGuideInfo:function
  - getGuideInfo(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GuideInfo>>
  - - Defined in generated-client/api/live-tv-api.ts:2312
    summary
    Get guid info.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GuideInfo>>
- getLineups:function
  - getLineups(id?: string, type?: string, location?: string, country?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
  - - Defined in generated-client/api/live-tv-api.ts:2326
    summary
    Gets available lineups.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional id: string
    - Optional type: string
    - Optional location: string
    - Optional country: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
- getLiveRecordingFile:function
  - getLiveRecordingFile(recordingId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/live-tv-api.ts:2337
    summary
    Gets a live tv recording stream.
    
    throws
    {RequiredError}
    
    Parameters
    - recordingId: string
      Recording id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getLiveStreamFile:function
  - getLiveStreamFile(streamId: string, container: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/live-tv-api.ts:2349
    summary
    Gets a live tv channel stream.
    
    throws
    {RequiredError}
    
    Parameters
    - streamId: string
      Stream id.
    - container: string
      Container type.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getLiveTvChannels:function
  - getLiveTvChannels(type?: ChannelType, userId?: string, startIndex?: number, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, limit?: number, isFavorite?: boolean, isLiked?: boolean, isDisliked?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, sortBy?: string[], sortOrder?: SortOrder, enableFavoriteSorting?: boolean, addCurrentProgram?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/live-tv-api.ts:2380
    summary
    Gets available live tv channels.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional type: ChannelType
    - Optional userId: string
    - Optional startIndex: number
    - Optional isMovie: boolean
    - Optional isSeries: boolean
    - Optional isNews: boolean
    - Optional isKids: boolean
    - Optional isSports: boolean
    - Optional limit: number
    - Optional isFavorite: boolean
    - Optional isLiked: boolean
    - Optional isDisliked: boolean
    - Optional enableImages: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional fields: ItemFields[]
    - Optional enableUserData: boolean
    - Optional sortBy: string[]
    - Optional sortOrder: SortOrder
    - Optional enableFavoriteSorting: boolean
    - Optional addCurrentProgram: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getLiveTvInfo:function
  - getLiveTvInfo(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveTvInfo>>
  - - Defined in generated-client/api/live-tv-api.ts:2390
    summary
    Gets available live tv services.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveTvInfo>>
- getLiveTvPrograms:function
  - getLiveTvPrograms(channelIds?: string[], userId?: string, minStartDate?: string, hasAired?: boolean, isAiring?: boolean, maxStartDate?: string, minEndDate?: string, maxEndDate?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, startIndex?: number, limit?: number, sortBy?: string[], sortOrder?: SortOrder[], genres?: string[], genreIds?: string[], enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, seriesTimerId?: string, librarySeriesId?: string, fields?: ItemFields[], enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/live-tv-api.ts:2427
    summary
    Gets available live tv epgs.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional channelIds: string[]
    - Optional userId: string
    - Optional minStartDate: string
    - Optional hasAired: boolean
    - Optional isAiring: boolean
    - Optional maxStartDate: string
    - Optional minEndDate: string
    - Optional maxEndDate: string
    - Optional isMovie: boolean
    - Optional isSeries: boolean
    - Optional isNews: boolean
    - Optional isKids: boolean
    - Optional isSports: boolean
    - Optional startIndex: number
    - Optional limit: number
    - Optional sortBy: string[]
    - Optional sortOrder: SortOrder[]
    - Optional genres: string[]
    - Optional genreIds: string[]
    - Optional enableImages: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional enableUserData: boolean
    - Optional seriesTimerId: string
    - Optional librarySeriesId: string
    - Optional fields: ItemFields[]
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getProgram:function
  - getProgram(programId: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
  - - Defined in generated-client/api/live-tv-api.ts:2439
    summary
    Gets a live tv program.
    
    throws
    {RequiredError}
    
    Parameters
    - programId: string
      Program id.
    - Optional userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
- getPrograms:function
  - getPrograms(getProgramsDto?: GetProgramsDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/live-tv-api.ts:2450
    summary
    Gets available live tv epgs.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional getProgramsDto: GetProgramsDto
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getRecommendedPrograms:function
  - getRecommendedPrograms(userId?: string, limit?: number, isAiring?: boolean, hasAired?: boolean, isSeries?: boolean, isMovie?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], genreIds?: string[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/live-tv-api.ts:2476
    summary
    Gets recommended live tv epgs.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional limit: number
    - Optional isAiring: boolean
    - Optional hasAired: boolean
    - Optional isSeries: boolean
    - Optional isMovie: boolean
    - Optional isNews: boolean
    - Optional isKids: boolean
    - Optional isSports: boolean
    - Optional enableImages: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional genreIds: string[]
    - Optional fields: ItemFields[]
    - Optional enableUserData: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getRecording:function
  - getRecording(recordingId: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
  - - Defined in generated-client/api/live-tv-api.ts:2488
    summary
    Gets a live tv recording.
    
    throws
    {RequiredError}
    
    Parameters
    - recordingId: string
      Recording id.
    - Optional userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
- getRecordingFolders:function
  - getRecordingFolders(userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/live-tv-api.ts:2499
    summary
    Gets recording folders.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getRecordingGroup:function
  - getRecordingGroup(groupId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/live-tv-api.ts:2511
    summary
    Get recording group.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - groupId: string
      Group id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getRecordingGroups:function
  - getRecordingGroups(userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/live-tv-api.ts:2523
    summary
    Gets live tv recording groups.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getRecordings:function
  - getRecordings(channelId?: string, userId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, isMovie?: boolean, isSeries?: boolean, isKids?: boolean, isSports?: boolean, isNews?: boolean, isLibraryItem?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/live-tv-api.ts:2552
    summary
    Gets live tv recordings.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional channelId: string
    - Optional userId: string
    - Optional startIndex: number
    - Optional limit: number
    - Optional status: RecordingStatus
    - Optional isInProgress: boolean
    - Optional seriesTimerId: string
    - Optional enableImages: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional fields: ItemFields[]
    - Optional enableUserData: boolean
    - Optional isMovie: boolean
    - Optional isSeries: boolean
    - Optional isKids: boolean
    - Optional isSports: boolean
    - Optional isNews: boolean
    - Optional isLibraryItem: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getRecordingsSeries:function
  - getRecordingsSeries(channelId?: string, userId?: string, groupId?: string, startIndex?: number, limit?: number, status?: RecordingStatus, isInProgress?: boolean, seriesTimerId?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], fields?: ItemFields[], enableUserData?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/live-tv-api.ts:2577
    summary
    Gets live tv recording series.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - Optional channelId: string
    - Optional userId: string
    - Optional groupId: string
    - Optional startIndex: number
    - Optional limit: number
    - Optional status: RecordingStatus
    - Optional isInProgress: boolean
    - Optional seriesTimerId: string
    - Optional enableImages: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional fields: ItemFields[]
    - Optional enableUserData: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getSchedulesDirectCountries:function
  - getSchedulesDirectCountries(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/live-tv-api.ts:2587
    summary
    Gets available countries.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getSeriesTimer:function
  - getSeriesTimer(timerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>>
  - - Defined in generated-client/api/live-tv-api.ts:2598
    summary
    Gets a live tv series timer.
    
    throws
    {RequiredError}
    
    Parameters
    - timerId: string
      Timer id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDto>>
- getSeriesTimers:function
  - getSeriesTimers(sortBy?: string, sortOrder?: SortOrder, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDtoQueryResult>>
  - - Defined in generated-client/api/live-tv-api.ts:2610
    summary
    Gets live tv series timers.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional sortBy: string
    - Optional sortOrder: SortOrder
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SeriesTimerInfoDtoQueryResult>>
- getTimer:function
  - getTimer(timerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDto>>
  - - Defined in generated-client/api/live-tv-api.ts:2621
    summary
    Gets a timer.
    
    throws
    {RequiredError}
    
    Parameters
    - timerId: string
      Timer id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDto>>
- getTimers:function
  - getTimers(channelId?: string, seriesTimerId?: string, isActive?: boolean, isScheduled?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDtoQueryResult>>
  - - Defined in generated-client/api/live-tv-api.ts:2635
    summary
    Gets the live tv timers.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional channelId: string
    - Optional seriesTimerId: string
    - Optional isActive: boolean
    - Optional isScheduled: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TimerInfoDtoQueryResult>>
- getTunerHostTypes:function
  - getTunerHostTypes(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
  - - Defined in generated-client/api/live-tv-api.ts:2645
    summary
    Get tuner host types.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
- resetTuner:function
  - resetTuner(tunerId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/live-tv-api.ts:2656
    summary
    Resets a tv tuner.
    
    throws
    {RequiredError}
    
    Parameters
    - tunerId: string
      Tuner id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- setChannelMapping:function
  - setChannelMapping(setChannelMappingDto: SetChannelMappingDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerChannelMapping>>
  - - Defined in generated-client/api/live-tv-api.ts:2667
    summary
    Set channel mappings.
    
    throws
    {RequiredError}
    
    Parameters
    - setChannelMappingDto: SetChannelMappingDto
      The set channel mapping dto.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TunerChannelMapping>>
- updateSeriesTimer:function
  - updateSeriesTimer(timerId: string, seriesTimerInfoDto?: SeriesTimerInfoDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/live-tv-api.ts:2679
    summary
    Updates a live tv series timer.
    
    throws
    {RequiredError}
    
    Parameters
    - timerId: string
      Timer id.
    - Optional seriesTimerInfoDto: SeriesTimerInfoDto
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- updateTimer:function
  - updateTimer(timerId: string, timerInfoDto?: TimerInfoDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/live-tv-api.ts:2691
    summary
    Updates a live tv timer.
    
    throws
    {RequiredError}
    
    Parameters
    - timerId: string
      Timer id.
    - Optional timerInfoDto: TimerInfoDto
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const LocalizationApiAxiosParamCreator

LocalizationApiAxiosParamCreator(configuration?: Configuration): { getCountries: (options?: any) => Promise<RequestArgs>; getCultures: (options?: any) => Promise<RequestArgs>; getLocalizationOptions: (options?: any) => Promise<RequestArgs>; getParentalRatings: (options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/localization-api.ts:35
LocalizationApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getCountries: (options?: any) => Promise<RequestArgs>; getCultures: (options?: any) => Promise<RequestArgs>; getLocalizationOptions: (options?: any) => Promise<RequestArgs>; getParentalRatings: (options?: any) => Promise<RequestArgs> }
- getCountries: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets known countries.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getCultures: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets known cultures.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getLocalizationOptions: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets localization options.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getParentalRatings: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets known parental ratings.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>

Const LocalizationApiFactory

LocalizationApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getCountries: any; getCultures: any; getLocalizationOptions: any; getParentalRatings: any }

- Defined in generated-client/api/localization-api.ts:226
LocalizationApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getCountries: any; getCultures: any; getLocalizationOptions: any; getParentalRatings: any }
- getCountries:function
  - getCountries(options?: any): AxiosPromise<CountryInfo[]>
  - - Defined in generated-client/api/localization-api.ts:235
    summary
    Gets known countries.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<CountryInfo[]>
- getCultures:function
  - getCultures(options?: any): AxiosPromise<CultureDto[]>
  - - Defined in generated-client/api/localization-api.ts:244
    summary
    Gets known cultures.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<CultureDto[]>
- getLocalizationOptions:function
  - getLocalizationOptions(options?: any): AxiosPromise<LocalizationOption[]>
  - - Defined in generated-client/api/localization-api.ts:253
    summary
    Gets localization options.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<LocalizationOption[]>
- getParentalRatings:function
  - getParentalRatings(options?: any): AxiosPromise<ParentalRating[]>
  - - Defined in generated-client/api/localization-api.ts:262
    summary
    Gets known parental ratings.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<ParentalRating[]>

Const LocalizationApiFp

LocalizationApiFp(configuration?: Configuration): { getCountries: any; getCultures: any; getLocalizationOptions: any; getParentalRatings: any }

- Defined in generated-client/api/localization-api.ts:176
LocalizationApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getCountries: any; getCultures: any; getLocalizationOptions: any; getParentalRatings: any }
- getCountries:function
  - getCountries(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CountryInfo[]>>
  - - Defined in generated-client/api/localization-api.ts:185
    summary
    Gets known countries.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CountryInfo[]>>
- getCultures:function
  - getCultures(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CultureDto[]>>
  - - Defined in generated-client/api/localization-api.ts:195
    summary
    Gets known cultures.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CultureDto[]>>
- getLocalizationOptions:function
  - getLocalizationOptions(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LocalizationOption[]>>
  - - Defined in generated-client/api/localization-api.ts:205
    summary
    Gets localization options.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LocalizationOption[]>>
- getParentalRatings:function
  - getParentalRatings(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParentalRating[]>>
  - - Defined in generated-client/api/localization-api.ts:215
    summary
    Gets known parental ratings.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParentalRating[]>>

Const MediaInfoApiAxiosParamCreator

MediaInfoApiAxiosParamCreator(configuration?: Configuration): { closeLiveStream: (liveStreamId: string, options?: any) => Promise<RequestArgs>; getBitrateTestBytes: (size?: number, options?: any) => Promise<RequestArgs>; getPlaybackInfo: (itemId: string, userId: string, options?: any) => Promise<RequestArgs>; getPostedPlaybackInfo: (itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: any) => Promise<RequestArgs>; openLiveStream: (openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/media-info-api.ts:37
MediaInfoApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { closeLiveStream: (liveStreamId: string, options?: any) => Promise<RequestArgs>; getBitrateTestBytes: (size?: number, options?: any) => Promise<RequestArgs>; getPlaybackInfo: (itemId: string, userId: string, options?: any) => Promise<RequestArgs>; getPostedPlaybackInfo: (itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: any) => Promise<RequestArgs>; openLiveStream: (openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: any) => Promise<RequestArgs> }
- closeLiveStream: (liveStreamId: string, options?: any) => Promise<RequestArgs>
  - - (liveStreamId: string, options?: any): Promise<RequestArgs>
    - summary
      Closes a media source.
      
      throws
      {RequiredError}
      
      Parameters
      - liveStreamId: string
        The livestream id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getBitrateTestBytes: (size?: number, options?: any) => Promise<RequestArgs>
  - - (size?: number, options?: any): Promise<RequestArgs>
    - summary
      Tests the network with a request with the size of the bitrate.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional size: number
      - options: any = {}
      Returns Promise<RequestArgs>
- getPlaybackInfo: (itemId: string, userId: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, userId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets live playback media info for an item.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - userId: string
        The user id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getPostedPlaybackInfo: (itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: any) => Promise<RequestArgs>
  - - (itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: any): Promise<RequestArgs>
    - For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.
      
      summary
      Gets live playback media info for an item.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional userId: string
      - Optional maxStreamingBitrate: number
      - Optional startTimeTicks: number
      - Optional audioStreamIndex: number
      - Optional subtitleStreamIndex: number
      - Optional maxAudioChannels: number
      - Optional mediaSourceId: string
      - Optional liveStreamId: string
      - Optional autoOpenLiveStream: boolean
      - Optional enableDirectPlay: boolean
      - Optional enableDirectStream: boolean
      - Optional enableTranscoding: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional playbackInfoDto: PlaybackInfoDto
      - options: any = {}
      Returns Promise<RequestArgs>
- openLiveStream: (openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: any) => Promise<RequestArgs>
  - - (openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: any): Promise<RequestArgs>
    - summary
      Opens a media source.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional openToken: string
      - Optional userId: string
      - Optional playSessionId: string
      - Optional maxStreamingBitrate: number
      - Optional startTimeTicks: number
      - Optional audioStreamIndex: number
      - Optional subtitleStreamIndex: number
      - Optional maxAudioChannels: number
      - Optional itemId: string
      - Optional enableDirectPlay: boolean
      - Optional enableDirectStream: boolean
      - Optional openLiveStreamDto: OpenLiveStreamDto
      - options: any = {}
      Returns Promise<RequestArgs>

Const MediaInfoApiFactory

MediaInfoApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { closeLiveStream: any; getBitrateTestBytes: any; getPlaybackInfo: any; getPostedPlaybackInfo: any; openLiveStream: any }

- Defined in generated-client/api/media-info-api.ts:463
MediaInfoApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { closeLiveStream: any; getBitrateTestBytes: any; getPlaybackInfo: any; getPostedPlaybackInfo: any; openLiveStream: any }
- closeLiveStream:function
  - closeLiveStream(liveStreamId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/media-info-api.ts:473
    summary
    Closes a media source.
    
    throws
    {RequiredError}
    
    Parameters
    - liveStreamId: string
      The livestream id.
    - Optional options: any
    Returns AxiosPromise<void>
- getBitrateTestBytes:function
  - getBitrateTestBytes(size?: number, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/media-info-api.ts:483
    summary
    Tests the network with a request with the size of the bitrate.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional size: number
    - Optional options: any
    Returns AxiosPromise<any>
- getPlaybackInfo:function
  - getPlaybackInfo(itemId: string, userId: string, options?: any): AxiosPromise<PlaybackInfoResponse>
  - - Defined in generated-client/api/media-info-api.ts:494
    summary
    Gets live playback media info for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - userId: string
      The user id.
    - Optional options: any
    Returns AxiosPromise<PlaybackInfoResponse>
- getPostedPlaybackInfo:function
  - getPostedPlaybackInfo(itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: any): AxiosPromise<PlaybackInfoResponse>
  - - Defined in generated-client/api/media-info-api.ts:519
    For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.
    
    summary
    Gets live playback media info for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional userId: string
    - Optional maxStreamingBitrate: number
    - Optional startTimeTicks: number
    - Optional audioStreamIndex: number
    - Optional subtitleStreamIndex: number
    - Optional maxAudioChannels: number
    - Optional mediaSourceId: string
    - Optional liveStreamId: string
    - Optional autoOpenLiveStream: boolean
    - Optional enableDirectPlay: boolean
    - Optional enableDirectStream: boolean
    - Optional enableTranscoding: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional playbackInfoDto: PlaybackInfoDto
    - Optional options: any
    Returns AxiosPromise<PlaybackInfoResponse>
- openLiveStream:function
  - openLiveStream(openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: any): AxiosPromise<LiveStreamResponse>
  - - Defined in generated-client/api/media-info-api.ts:540
    summary
    Opens a media source.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional openToken: string
    - Optional userId: string
    - Optional playSessionId: string
    - Optional maxStreamingBitrate: number
    - Optional startTimeTicks: number
    - Optional audioStreamIndex: number
    - Optional subtitleStreamIndex: number
    - Optional maxAudioChannels: number
    - Optional itemId: string
    - Optional enableDirectPlay: boolean
    - Optional enableDirectStream: boolean
    - Optional openLiveStreamDto: OpenLiveStreamDto
    - Optional options: any
    Returns AxiosPromise<LiveStreamResponse>

Const MediaInfoApiFp

MediaInfoApiFp(configuration?: Configuration): { closeLiveStream: any; getBitrateTestBytes: any; getPlaybackInfo: any; getPostedPlaybackInfo: any; openLiveStream: any }

- Defined in generated-client/api/media-info-api.ts:371
MediaInfoApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { closeLiveStream: any; getBitrateTestBytes: any; getPlaybackInfo: any; getPostedPlaybackInfo: any; openLiveStream: any }
- closeLiveStream:function
  - closeLiveStream(liveStreamId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/media-info-api.ts:381
    summary
    Closes a media source.
    
    throws
    {RequiredError}
    
    Parameters
    - liveStreamId: string
      The livestream id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getBitrateTestBytes:function
  - getBitrateTestBytes(size?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/media-info-api.ts:392
    summary
    Tests the network with a request with the size of the bitrate.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional size: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getPlaybackInfo:function
  - getPlaybackInfo(itemId: string, userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaybackInfoResponse>>
  - - Defined in generated-client/api/media-info-api.ts:404
    summary
    Gets live playback media info for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - userId: string
      The user id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaybackInfoResponse>>
- getPostedPlaybackInfo:function
  - getPostedPlaybackInfo(itemId: string, userId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, mediaSourceId?: string, liveStreamId?: string, autoOpenLiveStream?: boolean, enableDirectPlay?: boolean, enableDirectStream?: boolean, enableTranscoding?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, playbackInfoDto?: PlaybackInfoDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaybackInfoResponse>>
  - - Defined in generated-client/api/media-info-api.ts:430
    For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.
    
    summary
    Gets live playback media info for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional userId: string
    - Optional maxStreamingBitrate: number
    - Optional startTimeTicks: number
    - Optional audioStreamIndex: number
    - Optional subtitleStreamIndex: number
    - Optional maxAudioChannels: number
    - Optional mediaSourceId: string
    - Optional liveStreamId: string
    - Optional autoOpenLiveStream: boolean
    - Optional enableDirectPlay: boolean
    - Optional enableDirectStream: boolean
    - Optional enableTranscoding: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional playbackInfoDto: PlaybackInfoDto
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaybackInfoResponse>>
- openLiveStream:function
  - openLiveStream(openToken?: string, userId?: string, playSessionId?: string, maxStreamingBitrate?: number, startTimeTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, maxAudioChannels?: number, itemId?: string, enableDirectPlay?: boolean, enableDirectStream?: boolean, openLiveStreamDto?: OpenLiveStreamDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveStreamResponse>>
  - - Defined in generated-client/api/media-info-api.ts:452
    summary
    Opens a media source.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional openToken: string
    - Optional userId: string
    - Optional playSessionId: string
    - Optional maxStreamingBitrate: number
    - Optional startTimeTicks: number
    - Optional audioStreamIndex: number
    - Optional subtitleStreamIndex: number
    - Optional maxAudioChannels: number
    - Optional itemId: string
    - Optional enableDirectPlay: boolean
    - Optional enableDirectStream: boolean
    - Optional openLiveStreamDto: OpenLiveStreamDto
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LiveStreamResponse>>

Const MoviesApiAxiosParamCreator

MoviesApiAxiosParamCreator(configuration?: Configuration): { getMovieRecommendations: (userId?: string, parentId?: string, fields?: ItemFields[], categoryLimit?: number, itemLimit?: number, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/movies-api.ts:31
MoviesApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getMovieRecommendations: (userId?: string, parentId?: string, fields?: ItemFields[], categoryLimit?: number, itemLimit?: number, options?: any) => Promise<RequestArgs> }
- getMovieRecommendations: (userId?: string, parentId?: string, fields?: ItemFields[], categoryLimit?: number, itemLimit?: number, options?: any) => Promise<RequestArgs>
  - - (userId?: string, parentId?: string, fields?: ItemFields[], categoryLimit?: number, itemLimit?: number, options?: any): Promise<RequestArgs>
    - summary
      Gets movie recommendations.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional userId: string
      - Optional parentId: string
      - Optional fields: ItemFields[]
      - Optional categoryLimit: number
      - Optional itemLimit: number
      - options: any = {}
      Returns Promise<RequestArgs>

Const MoviesApiFactory

MoviesApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getMovieRecommendations: any }

- Defined in generated-client/api/movies-api.ts:123
MoviesApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getMovieRecommendations: any }
- getMovieRecommendations:function
  - getMovieRecommendations(userId?: string, parentId?: string, fields?: ItemFields[], categoryLimit?: number, itemLimit?: number, options?: any): AxiosPromise<RecommendationDto[]>
  - - Defined in generated-client/api/movies-api.ts:137
    summary
    Gets movie recommendations.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional categoryLimit: number
    - Optional itemLimit: number
    - Optional options: any
    Returns AxiosPromise<RecommendationDto[]>

Const MoviesApiFp

MoviesApiFp(configuration?: Configuration): { getMovieRecommendations: any }

- Defined in generated-client/api/movies-api.ts:98
MoviesApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getMovieRecommendations: any }
- getMovieRecommendations:function
  - getMovieRecommendations(userId?: string, parentId?: string, fields?: ItemFields[], categoryLimit?: number, itemLimit?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecommendationDto[]>>
  - - Defined in generated-client/api/movies-api.ts:112
    summary
    Gets movie recommendations.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional categoryLimit: number
    - Optional itemLimit: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecommendationDto[]>>

Const MusicGenresApiAxiosParamCreator

MusicGenresApiAxiosParamCreator(configuration?: Configuration): { getMusicGenre: (genreName: string, userId?: string, options?: any) => Promise<RequestArgs>; getMusicGenres: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/music-genres-api.ts:35
MusicGenresApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getMusicGenre: (genreName: string, userId?: string, options?: any) => Promise<RequestArgs>; getMusicGenres: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }
- getMusicGenre: (genreName: string, userId?: string, options?: any) => Promise<RequestArgs>
  - - (genreName: string, userId?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a music genre, by name.
      
      throws
      {RequiredError}
      
      Parameters
      - genreName: string
        The genre name.
      - Optional userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getMusicGenres: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
  - - (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets all music genres from a given item, folder, or the entire library.
      
      deprecated
      throws
      {RequiredError}
      
      Parameters
      - Optional startIndex: number
      - Optional limit: number
      - Optional searchTerm: string
      - Optional parentId: string
      - Optional fields: ItemFields[]
      - Optional excludeItemTypes: string[]
      - Optional includeItemTypes: string[]
      - Optional isFavorite: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional userId: string
      - Optional nameStartsWithOrGreater: string
      - Optional nameStartsWith: string
      - Optional nameLessThan: string
      - Optional enableImages: boolean
      - Optional enableTotalRecordCount: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const MusicGenresApiFactory

MusicGenresApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getMusicGenre: any; getMusicGenres: any }

- Defined in generated-client/api/music-genres-api.ts:249
MusicGenresApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getMusicGenre: any; getMusicGenres: any }
- getMusicGenre:function
  - getMusicGenre(genreName: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>
  - - Defined in generated-client/api/music-genres-api.ts:260
    summary
    Gets a music genre, by name.
    
    throws
    {RequiredError}
    
    Parameters
    - genreName: string
      The genre name.
    - Optional userId: string
    - Optional options: any
    Returns AxiosPromise<BaseItemDto>
- getMusicGenres:function
  - getMusicGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/music-genres-api.ts:286
    summary
    Gets all music genres from a given item, folder, or the entire library.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - Optional startIndex: number
    - Optional limit: number
    - Optional searchTerm: string
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional isFavorite: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional userId: string
    - Optional nameStartsWithOrGreater: string
    - Optional nameStartsWith: string
    - Optional nameLessThan: string
    - Optional enableImages: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>

Const MusicGenresApiFp

MusicGenresApiFp(configuration?: Configuration): { getMusicGenre: any; getMusicGenres: any }

- Defined in generated-client/api/music-genres-api.ts:200
MusicGenresApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getMusicGenre: any; getMusicGenres: any }
- getMusicGenre:function
  - getMusicGenre(genreName: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
  - - Defined in generated-client/api/music-genres-api.ts:211
    summary
    Gets a music genre, by name.
    
    throws
    {RequiredError}
    
    Parameters
    - genreName: string
      The genre name.
    - Optional userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
- getMusicGenres:function
  - getMusicGenres(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/music-genres-api.ts:238
    summary
    Gets all music genres from a given item, folder, or the entire library.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - Optional startIndex: number
    - Optional limit: number
    - Optional searchTerm: string
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional isFavorite: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional userId: string
    - Optional nameStartsWithOrGreater: string
    - Optional nameStartsWith: string
    - Optional nameLessThan: string
    - Optional enableImages: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>

Const NotificationsApiAxiosParamCreator

NotificationsApiAxiosParamCreator(configuration?: Configuration): { createAdminNotification: (adminNotificationDto: AdminNotificationDto, options?: any) => Promise<RequestArgs>; getNotificationServices: (options?: any) => Promise<RequestArgs>; getNotificationTypes: (options?: any) => Promise<RequestArgs>; getNotifications: (userId: string, options?: any) => Promise<RequestArgs>; getNotificationsSummary: (userId: string, options?: any) => Promise<RequestArgs>; setRead: (userId: string, options?: any) => Promise<RequestArgs>; setUnread: (userId: string, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/notifications-api.ts:37
NotificationsApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { createAdminNotification: (adminNotificationDto: AdminNotificationDto, options?: any) => Promise<RequestArgs>; getNotificationServices: (options?: any) => Promise<RequestArgs>; getNotificationTypes: (options?: any) => Promise<RequestArgs>; getNotifications: (userId: string, options?: any) => Promise<RequestArgs>; getNotificationsSummary: (userId: string, options?: any) => Promise<RequestArgs>; setRead: (userId: string, options?: any) => Promise<RequestArgs>; setUnread: (userId: string, options?: any) => Promise<RequestArgs> }
- createAdminNotification: (adminNotificationDto: AdminNotificationDto, options?: any) => Promise<RequestArgs>
  - - (adminNotificationDto: AdminNotificationDto, options?: any): Promise<RequestArgs>
    - summary
      Sends a notification to all admins.
      
      throws
      {RequiredError}
      
      Parameters
      - adminNotificationDto: AdminNotificationDto
        The notification request.
      - options: any = {}
      Returns Promise<RequestArgs>
- getNotificationServices: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets notification services.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getNotificationTypes: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets notification types.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getNotifications: (userId: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a user's notifications.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getNotificationsSummary: (userId: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a user's notification summary.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- setRead: (userId: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, options?: any): Promise<RequestArgs>
    - summary
      Sets notifications as read.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- setUnread: (userId: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, options?: any): Promise<RequestArgs>
    - summary
      Sets notifications as unread.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
      - options: any = {}
      Returns Promise<RequestArgs>

Const NotificationsApiFactory

NotificationsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { createAdminNotification: any; getNotificationServices: any; getNotificationTypes: any; getNotifications: any; getNotificationsSummary: any; setRead: any; setUnread: any }

- Defined in generated-client/api/notifications-api.ts:384
NotificationsApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { createAdminNotification: any; getNotificationServices: any; getNotificationTypes: any; getNotifications: any; getNotificationsSummary: any; setRead: any; setUnread: any }
- createAdminNotification:function
  - createAdminNotification(adminNotificationDto: AdminNotificationDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/notifications-api.ts:394
    summary
    Sends a notification to all admins.
    
    throws
    {RequiredError}
    
    Parameters
    - adminNotificationDto: AdminNotificationDto
      The notification request.
    - Optional options: any
    Returns AxiosPromise<void>
- getNotificationServices:function
  - getNotificationServices(options?: any): AxiosPromise<NameIdPair[]>
  - - Defined in generated-client/api/notifications-api.ts:403
    summary
    Gets notification services.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<NameIdPair[]>
- getNotificationTypes:function
  - getNotificationTypes(options?: any): AxiosPromise<NotificationTypeInfo[]>
  - - Defined in generated-client/api/notifications-api.ts:412
    summary
    Gets notification types.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<NotificationTypeInfo[]>
- getNotifications:function
  - getNotifications(userId: string, options?: any): AxiosPromise<NotificationResultDto>
  - - Defined in generated-client/api/notifications-api.ts:422
    summary
    Gets a user's notifications.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
    - Optional options: any
    Returns AxiosPromise<NotificationResultDto>
- getNotificationsSummary:function
  - getNotificationsSummary(userId: string, options?: any): AxiosPromise<NotificationsSummaryDto>
  - - Defined in generated-client/api/notifications-api.ts:432
    summary
    Gets a user's notification summary.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
    - Optional options: any
    Returns AxiosPromise<NotificationsSummaryDto>
- setRead:function
  - setRead(userId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/notifications-api.ts:442
    summary
    Sets notifications as read.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
    - Optional options: any
    Returns AxiosPromise<void>
- setUnread:function
  - setUnread(userId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/notifications-api.ts:452
    summary
    Sets notifications as unread.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
    - Optional options: any
    Returns AxiosPromise<void>

Const NotificationsApiFp

NotificationsApiFp(configuration?: Configuration): { createAdminNotification: any; getNotificationServices: any; getNotificationTypes: any; getNotifications: any; getNotificationsSummary: any; setRead: any; setUnread: any }

- Defined in generated-client/api/notifications-api.ts:299
NotificationsApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { createAdminNotification: any; getNotificationServices: any; getNotificationTypes: any; getNotifications: any; getNotificationsSummary: any; setRead: any; setUnread: any }
- createAdminNotification:function
  - createAdminNotification(adminNotificationDto: AdminNotificationDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/notifications-api.ts:309
    summary
    Sends a notification to all admins.
    
    throws
    {RequiredError}
    
    Parameters
    - adminNotificationDto: AdminNotificationDto
      The notification request.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getNotificationServices:function
  - getNotificationServices(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
  - - Defined in generated-client/api/notifications-api.ts:319
    summary
    Gets notification services.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
- getNotificationTypes:function
  - getNotificationTypes(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationTypeInfo[]>>
  - - Defined in generated-client/api/notifications-api.ts:329
    summary
    Gets notification types.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationTypeInfo[]>>
- getNotifications:function
  - getNotifications(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationResultDto>>
  - - Defined in generated-client/api/notifications-api.ts:340
    summary
    Gets a user's notifications.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationResultDto>>
- getNotificationsSummary:function
  - getNotificationsSummary(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationsSummaryDto>>
  - - Defined in generated-client/api/notifications-api.ts:351
    summary
    Gets a user's notification summary.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationsSummaryDto>>
- setRead:function
  - setRead(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/notifications-api.ts:362
    summary
    Sets notifications as read.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- setUnread:function
  - setUnread(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/notifications-api.ts:373
    summary
    Sets notifications as unread.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const PackageApiAxiosParamCreator

PackageApiAxiosParamCreator(configuration?: Configuration): { cancelPackageInstallation: (packageId: string, options?: any) => Promise<RequestArgs>; getPackageInfo: (name: string, assemblyGuid?: string, options?: any) => Promise<RequestArgs>; getPackages: (options?: any) => Promise<RequestArgs>; getRepositories: (options?: any) => Promise<RequestArgs>; installPackage: (name: string, assemblyGuid?: string, version?: string, repositoryUrl?: string, options?: any) => Promise<RequestArgs>; setRepositories: (repositoryInfo: RepositoryInfo[], options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/package-api.ts:33
PackageApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { cancelPackageInstallation: (packageId: string, options?: any) => Promise<RequestArgs>; getPackageInfo: (name: string, assemblyGuid?: string, options?: any) => Promise<RequestArgs>; getPackages: (options?: any) => Promise<RequestArgs>; getRepositories: (options?: any) => Promise<RequestArgs>; installPackage: (name: string, assemblyGuid?: string, version?: string, repositoryUrl?: string, options?: any) => Promise<RequestArgs>; setRepositories: (repositoryInfo: RepositoryInfo[], options?: any) => Promise<RequestArgs> }
- cancelPackageInstallation: (packageId: string, options?: any) => Promise<RequestArgs>
  - - (packageId: string, options?: any): Promise<RequestArgs>
    - summary
      Cancels a package installation.
      
      throws
      {RequiredError}
      
      Parameters
      - packageId: string
        Installation Id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getPackageInfo: (name: string, assemblyGuid?: string, options?: any) => Promise<RequestArgs>
  - - (name: string, assemblyGuid?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a package by name or assembly GUID.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        The name of the package.
      - Optional assemblyGuid: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getPackages: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets available packages.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getRepositories: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets all package repositories.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- installPackage: (name: string, assemblyGuid?: string, version?: string, repositoryUrl?: string, options?: any) => Promise<RequestArgs>
  - - (name: string, assemblyGuid?: string, version?: string, repositoryUrl?: string, options?: any): Promise<RequestArgs>
    - summary
      Installs a package.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Package name.
      - Optional assemblyGuid: string
      - Optional version: string
      - Optional repositoryUrl: string
      - options: any = {}
      Returns Promise<RequestArgs>
- setRepositories: (repositoryInfo: RepositoryInfo[], options?: any) => Promise<RequestArgs>
  - - (repositoryInfo: RepositoryInfo[], options?: any): Promise<RequestArgs>
    - summary
      Sets the enabled and existing package repositories.
      
      throws
      {RequiredError}
      
      Parameters
      - repositoryInfo: RepositoryInfo[]
        The list of package repositories.
      - options: any = {}
      Returns Promise<RequestArgs>

Const PackageApiFactory

PackageApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { cancelPackageInstallation: any; getPackageInfo: any; getPackages: any; getRepositories: any; installPackage: any; setRepositories: any }

- Defined in generated-client/api/package-api.ts:356
PackageApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { cancelPackageInstallation: any; getPackageInfo: any; getPackages: any; getRepositories: any; installPackage: any; setRepositories: any }
- cancelPackageInstallation:function
  - cancelPackageInstallation(packageId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/package-api.ts:366
    summary
    Cancels a package installation.
    
    throws
    {RequiredError}
    
    Parameters
    - packageId: string
      Installation Id.
    - Optional options: any
    Returns AxiosPromise<void>
- getPackageInfo:function
  - getPackageInfo(name: string, assemblyGuid?: string, options?: any): AxiosPromise<PackageInfo>
  - - Defined in generated-client/api/package-api.ts:377
    summary
    Gets a package by name or assembly GUID.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      The name of the package.
    - Optional assemblyGuid: string
    - Optional options: any
    Returns AxiosPromise<PackageInfo>
- getPackages:function
  - getPackages(options?: any): AxiosPromise<PackageInfo[]>
  - - Defined in generated-client/api/package-api.ts:386
    summary
    Gets available packages.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<PackageInfo[]>
- getRepositories:function
  - getRepositories(options?: any): AxiosPromise<RepositoryInfo[]>
  - - Defined in generated-client/api/package-api.ts:395
    summary
    Gets all package repositories.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<RepositoryInfo[]>
- installPackage:function
  - installPackage(name: string, assemblyGuid?: string, version?: string, repositoryUrl?: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/package-api.ts:408
    summary
    Installs a package.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Package name.
    - Optional assemblyGuid: string
    - Optional version: string
    - Optional repositoryUrl: string
    - Optional options: any
    Returns AxiosPromise<void>
- setRepositories:function
  - setRepositories(repositoryInfo: RepositoryInfo[], options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/package-api.ts:418
    summary
    Sets the enabled and existing package repositories.
    
    throws
    {RequiredError}
    
    Parameters
    - repositoryInfo: RepositoryInfo[]
      The list of package repositories.
    - Optional options: any
    Returns AxiosPromise<void>

Const PackageApiFp

PackageApiFp(configuration?: Configuration): { cancelPackageInstallation: any; getPackageInfo: any; getPackages: any; getRepositories: any; installPackage: any; setRepositories: any }

- Defined in generated-client/api/package-api.ts:278
PackageApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { cancelPackageInstallation: any; getPackageInfo: any; getPackages: any; getRepositories: any; installPackage: any; setRepositories: any }
- cancelPackageInstallation:function
  - cancelPackageInstallation(packageId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/package-api.ts:288
    summary
    Cancels a package installation.
    
    throws
    {RequiredError}
    
    Parameters
    - packageId: string
      Installation Id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getPackageInfo:function
  - getPackageInfo(name: string, assemblyGuid?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PackageInfo>>
  - - Defined in generated-client/api/package-api.ts:300
    summary
    Gets a package by name or assembly GUID.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      The name of the package.
    - Optional assemblyGuid: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PackageInfo>>
- getPackages:function
  - getPackages(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PackageInfo[]>>
  - - Defined in generated-client/api/package-api.ts:310
    summary
    Gets available packages.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PackageInfo[]>>
- getRepositories:function
  - getRepositories(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RepositoryInfo[]>>
  - - Defined in generated-client/api/package-api.ts:320
    summary
    Gets all package repositories.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RepositoryInfo[]>>
- installPackage:function
  - installPackage(name: string, assemblyGuid?: string, version?: string, repositoryUrl?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/package-api.ts:334
    summary
    Installs a package.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Package name.
    - Optional assemblyGuid: string
    - Optional version: string
    - Optional repositoryUrl: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- setRepositories:function
  - setRepositories(repositoryInfo: RepositoryInfo[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/package-api.ts:345
    summary
    Sets the enabled and existing package repositories.
    
    throws
    {RequiredError}
    
    Parameters
    - repositoryInfo: RepositoryInfo[]
      The list of package repositories.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const PersonsApiAxiosParamCreator

PersonsApiAxiosParamCreator(configuration?: Configuration): { getPerson: (name: string, userId?: string, options?: any) => Promise<RequestArgs>; getPersons: (limit?: number, searchTerm?: string, fields?: ItemFields[], filters?: ItemFilter[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludePersonTypes?: string[], personTypes?: string[], appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/persons-api.ts:39
PersonsApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getPerson: (name: string, userId?: string, options?: any) => Promise<RequestArgs>; getPersons: (limit?: number, searchTerm?: string, fields?: ItemFields[], filters?: ItemFilter[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludePersonTypes?: string[], personTypes?: string[], appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: any) => Promise<RequestArgs> }
- getPerson: (name: string, userId?: string, options?: any) => Promise<RequestArgs>
  - - (name: string, userId?: string, options?: any): Promise<RequestArgs>
    - summary
      Get person by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Person name.
      - Optional userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getPersons: (limit?: number, searchTerm?: string, fields?: ItemFields[], filters?: ItemFilter[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludePersonTypes?: string[], personTypes?: string[], appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: any) => Promise<RequestArgs>
  - - (limit?: number, searchTerm?: string, fields?: ItemFields[], filters?: ItemFilter[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludePersonTypes?: string[], personTypes?: string[], appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets all persons.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional limit: number
      - Optional searchTerm: string
      - Optional fields: ItemFields[]
      - Optional filters: ItemFilter[]
      - Optional isFavorite: boolean
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional excludePersonTypes: string[]
      - Optional personTypes: string[]
      - Optional appearsInItemId: string
      - Optional userId: string
      - Optional enableImages: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const PersonsApiFactory

PersonsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getPerson: any; getPersons: any }

- Defined in generated-client/api/persons-api.ts:233
PersonsApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getPerson: any; getPersons: any }
- getPerson:function
  - getPerson(name: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>
  - - Defined in generated-client/api/persons-api.ts:244
    summary
    Get person by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Person name.
    - Optional userId: string
    - Optional options: any
    Returns AxiosPromise<BaseItemDto>
- getPersons:function
  - getPersons(limit?: number, searchTerm?: string, fields?: ItemFields[], filters?: ItemFilter[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludePersonTypes?: string[], personTypes?: string[], appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/persons-api.ts:266
    summary
    Gets all persons.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional limit: number
    - Optional searchTerm: string
    - Optional fields: ItemFields[]
    - Optional filters: ItemFilter[]
    - Optional isFavorite: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional excludePersonTypes: string[]
    - Optional personTypes: string[]
    - Optional appearsInItemId: string
    - Optional userId: string
    - Optional enableImages: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>

Const PersonsApiFp

PersonsApiFp(configuration?: Configuration): { getPerson: any; getPersons: any }

- Defined in generated-client/api/persons-api.ts:188
PersonsApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getPerson: any; getPersons: any }
- getPerson:function
  - getPerson(name: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
  - - Defined in generated-client/api/persons-api.ts:199
    summary
    Get person by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Person name.
    - Optional userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
- getPersons:function
  - getPersons(limit?: number, searchTerm?: string, fields?: ItemFields[], filters?: ItemFilter[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], excludePersonTypes?: string[], personTypes?: string[], appearsInItemId?: string, userId?: string, enableImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/persons-api.ts:222
    summary
    Gets all persons.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional limit: number
    - Optional searchTerm: string
    - Optional fields: ItemFields[]
    - Optional filters: ItemFilter[]
    - Optional isFavorite: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional excludePersonTypes: string[]
    - Optional personTypes: string[]
    - Optional appearsInItemId: string
    - Optional userId: string
    - Optional enableImages: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>

Const PlaylistsApiAxiosParamCreator

PlaylistsApiAxiosParamCreator(configuration?: Configuration): { addToPlaylist: (playlistId: string, ids?: string[], userId?: string, options?: any) => Promise<RequestArgs>; createPlaylist: (name?: string, ids?: string[], userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options?: any) => Promise<RequestArgs>; getPlaylistItems: (playlistId: string, userId: string, startIndex?: number, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; moveItem: (playlistId: string, itemId: string, newIndex: number, options?: any) => Promise<RequestArgs>; removeFromPlaylist: (playlistId: string, entryIds?: string[], options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/playlists-api.ts:37
PlaylistsApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { addToPlaylist: (playlistId: string, ids?: string[], userId?: string, options?: any) => Promise<RequestArgs>; createPlaylist: (name?: string, ids?: string[], userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options?: any) => Promise<RequestArgs>; getPlaylistItems: (playlistId: string, userId: string, startIndex?: number, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>; moveItem: (playlistId: string, itemId: string, newIndex: number, options?: any) => Promise<RequestArgs>; removeFromPlaylist: (playlistId: string, entryIds?: string[], options?: any) => Promise<RequestArgs> }
- addToPlaylist: (playlistId: string, ids?: string[], userId?: string, options?: any) => Promise<RequestArgs>
  - - (playlistId: string, ids?: string[], userId?: string, options?: any): Promise<RequestArgs>
    - summary
      Adds items to a playlist.
      
      throws
      {RequiredError}
      
      Parameters
      - playlistId: string
        The playlist id.
      - Optional ids: string[]
      - Optional userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- createPlaylist: (name?: string, ids?: string[], userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options?: any) => Promise<RequestArgs>
  - - (name?: string, ids?: string[], userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options?: any): Promise<RequestArgs>
    - For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.
      
      summary
      Creates a new playlist.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional name: string
      - Optional ids: string[]
      - Optional userId: string
      - Optional mediaType: string
      - Optional createPlaylistDto: CreatePlaylistDto
      - options: any = {}
      Returns Promise<RequestArgs>
- getPlaylistItems: (playlistId: string, userId: string, startIndex?: number, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any) => Promise<RequestArgs>
  - - (playlistId: string, userId: string, startIndex?: number, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<RequestArgs>
    - summary
      Gets the original items of a playlist.
      
      throws
      {RequiredError}
      
      Parameters
      - playlistId: string
        The playlist id.
      - userId: string
        User id.
      - Optional startIndex: number
      - Optional limit: number
      - Optional fields: ItemFields[]
      - Optional enableImages: boolean
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - options: any = {}
      Returns Promise<RequestArgs>
- moveItem: (playlistId: string, itemId: string, newIndex: number, options?: any) => Promise<RequestArgs>
  - - (playlistId: string, itemId: string, newIndex: number, options?: any): Promise<RequestArgs>
    - summary
      Moves a playlist item.
      
      throws
      {RequiredError}
      
      Parameters
      - playlistId: string
        The playlist id.
      - itemId: string
        The item id.
      - newIndex: number
        The new index.
      - options: any = {}
      Returns Promise<RequestArgs>
- removeFromPlaylist: (playlistId: string, entryIds?: string[], options?: any) => Promise<RequestArgs>
  - - (playlistId: string, entryIds?: string[], options?: any): Promise<RequestArgs>
    - summary
      Removes items from a playlist.
      
      throws
      {RequiredError}
      
      Parameters
      - playlistId: string
        The playlist id.
      - Optional entryIds: string[]
      - options: any = {}
      Returns Promise<RequestArgs>

Const PlaylistsApiFactory

PlaylistsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { addToPlaylist: any; createPlaylist: any; getPlaylistItems: any; moveItem: any; removeFromPlaylist: any }

- Defined in generated-client/api/playlists-api.ts:398
PlaylistsApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { addToPlaylist: any; createPlaylist: any; getPlaylistItems: any; moveItem: any; removeFromPlaylist: any }
- addToPlaylist:function
  - addToPlaylist(playlistId: string, ids?: string[], userId?: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/playlists-api.ts:410
    summary
    Adds items to a playlist.
    
    throws
    {RequiredError}
    
    Parameters
    - playlistId: string
      The playlist id.
    - Optional ids: string[]
    - Optional userId: string
    - Optional options: any
    Returns AxiosPromise<void>
- createPlaylist:function
  - createPlaylist(name?: string, ids?: string[], userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options?: any): AxiosPromise<PlaylistCreationResult>
  - - Defined in generated-client/api/playlists-api.ts:424
    For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.
    
    summary
    Creates a new playlist.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional name: string
    - Optional ids: string[]
    - Optional userId: string
    - Optional mediaType: string
    - Optional createPlaylistDto: CreatePlaylistDto
    - Optional options: any
    Returns AxiosPromise<PlaylistCreationResult>
- getPlaylistItems:function
  - getPlaylistItems(playlistId: string, userId: string, startIndex?: number, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/playlists-api.ts:442
    summary
    Gets the original items of a playlist.
    
    throws
    {RequiredError}
    
    Parameters
    - playlistId: string
      The playlist id.
    - userId: string
      User id.
    - Optional startIndex: number
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- moveItem:function
  - moveItem(playlistId: string, itemId: string, newIndex: number, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/playlists-api.ts:454
    summary
    Moves a playlist item.
    
    throws
    {RequiredError}
    
    Parameters
    - playlistId: string
      The playlist id.
    - itemId: string
      The item id.
    - newIndex: number
      The new index.
    - Optional options: any
    Returns AxiosPromise<void>
- removeFromPlaylist:function
  - removeFromPlaylist(playlistId: string, entryIds?: string[], options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/playlists-api.ts:465
    summary
    Removes items from a playlist.
    
    throws
    {RequiredError}
    
    Parameters
    - playlistId: string
      The playlist id.
    - Optional entryIds: string[]
    - Optional options: any
    Returns AxiosPromise<void>

Const PlaylistsApiFp

PlaylistsApiFp(configuration?: Configuration): { addToPlaylist: any; createPlaylist: any; getPlaylistItems: any; moveItem: any; removeFromPlaylist: any }

- Defined in generated-client/api/playlists-api.ts:316
PlaylistsApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { addToPlaylist: any; createPlaylist: any; getPlaylistItems: any; moveItem: any; removeFromPlaylist: any }
- addToPlaylist:function
  - addToPlaylist(playlistId: string, ids?: string[], userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/playlists-api.ts:328
    summary
    Adds items to a playlist.
    
    throws
    {RequiredError}
    
    Parameters
    - playlistId: string
      The playlist id.
    - Optional ids: string[]
    - Optional userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- createPlaylist:function
  - createPlaylist(name?: string, ids?: string[], userId?: string, mediaType?: string, createPlaylistDto?: CreatePlaylistDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaylistCreationResult>>
  - - Defined in generated-client/api/playlists-api.ts:343
    For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.
    
    summary
    Creates a new playlist.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional name: string
    - Optional ids: string[]
    - Optional userId: string
    - Optional mediaType: string
    - Optional createPlaylistDto: CreatePlaylistDto
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaylistCreationResult>>
- getPlaylistItems:function
  - getPlaylistItems(playlistId: string, userId: string, startIndex?: number, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/playlists-api.ts:362
    summary
    Gets the original items of a playlist.
    
    throws
    {RequiredError}
    
    Parameters
    - playlistId: string
      The playlist id.
    - userId: string
      User id.
    - Optional startIndex: number
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional enableImages: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- moveItem:function
  - moveItem(playlistId: string, itemId: string, newIndex: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/playlists-api.ts:375
    summary
    Moves a playlist item.
    
    throws
    {RequiredError}
    
    Parameters
    - playlistId: string
      The playlist id.
    - itemId: string
      The item id.
    - newIndex: number
      The new index.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- removeFromPlaylist:function
  - removeFromPlaylist(playlistId: string, entryIds?: string[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/playlists-api.ts:387
    summary
    Removes items from a playlist.
    
    throws
    {RequiredError}
    
    Parameters
    - playlistId: string
      The playlist id.
    - Optional entryIds: string[]
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const PlaystateApiAxiosParamCreator

PlaystateApiAxiosParamCreator(configuration?: Configuration): { markPlayedItem: (userId: string, itemId: string, datePlayed?: string, options?: any) => Promise<RequestArgs>; markUnplayedItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; onPlaybackProgress: (userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: any) => Promise<RequestArgs>; onPlaybackStart: (userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: any) => Promise<RequestArgs>; onPlaybackStopped: (userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: any) => Promise<RequestArgs>; pingPlaybackSession: (playSessionId: string, options?: any) => Promise<RequestArgs>; reportPlaybackProgress: (playbackProgressInfo?: PlaybackProgressInfo, options?: any) => Promise<RequestArgs>; reportPlaybackStart: (playbackStartInfo?: PlaybackStartInfo, options?: any) => Promise<RequestArgs>; reportPlaybackStopped: (playbackStopInfo?: PlaybackStopInfo, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/playstate-api.ts:39
PlaystateApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { markPlayedItem: (userId: string, itemId: string, datePlayed?: string, options?: any) => Promise<RequestArgs>; markUnplayedItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; onPlaybackProgress: (userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: any) => Promise<RequestArgs>; onPlaybackStart: (userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: any) => Promise<RequestArgs>; onPlaybackStopped: (userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: any) => Promise<RequestArgs>; pingPlaybackSession: (playSessionId: string, options?: any) => Promise<RequestArgs>; reportPlaybackProgress: (playbackProgressInfo?: PlaybackProgressInfo, options?: any) => Promise<RequestArgs>; reportPlaybackStart: (playbackStartInfo?: PlaybackStartInfo, options?: any) => Promise<RequestArgs>; reportPlaybackStopped: (playbackStopInfo?: PlaybackStopInfo, options?: any) => Promise<RequestArgs> }
- markPlayedItem: (userId: string, itemId: string, datePlayed?: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, itemId: string, datePlayed?: string, options?: any): Promise<RequestArgs>
    - summary
      Marks an item as played for user.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - itemId: string
        Item id.
      - Optional datePlayed: string
      - options: any = {}
      Returns Promise<RequestArgs>
- markUnplayedItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Marks an item as unplayed for user.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - itemId: string
        Item id.
      - options: any = {}
      Returns Promise<RequestArgs>
- onPlaybackProgress: (userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: any) => Promise<RequestArgs>
  - - (userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Reports a user's playback progress.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - itemId: string
        Item id.
      - Optional mediaSourceId: string
      - Optional positionTicks: number
      - Optional audioStreamIndex: number
      - Optional subtitleStreamIndex: number
      - Optional volumeLevel: number
      - Optional playMethod: PlayMethod
      - Optional liveStreamId: string
      - Optional playSessionId: string
      - Optional repeatMode: RepeatMode
      - Optional isPaused: boolean
      - Optional isMuted: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- onPlaybackStart: (userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: any) => Promise<RequestArgs>
  - - (userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Reports that a user has begun playing an item.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - itemId: string
        Item id.
      - Optional mediaSourceId: string
      - Optional audioStreamIndex: number
      - Optional subtitleStreamIndex: number
      - Optional playMethod: PlayMethod
      - Optional liveStreamId: string
      - Optional playSessionId: string
      - Optional canSeek: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- onPlaybackStopped: (userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: any): Promise<RequestArgs>
    - summary
      Reports that a user has stopped playing an item.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - itemId: string
        Item id.
      - Optional mediaSourceId: string
      - Optional nextMediaType: string
      - Optional positionTicks: number
      - Optional liveStreamId: string
      - Optional playSessionId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- pingPlaybackSession: (playSessionId: string, options?: any) => Promise<RequestArgs>
  - - (playSessionId: string, options?: any): Promise<RequestArgs>
    - summary
      Pings a playback session.
      
      throws
      {RequiredError}
      
      Parameters
      - playSessionId: string
        Playback session id.
      - options: any = {}
      Returns Promise<RequestArgs>
- reportPlaybackProgress: (playbackProgressInfo?: PlaybackProgressInfo, options?: any) => Promise<RequestArgs>
  - - (playbackProgressInfo?: PlaybackProgressInfo, options?: any): Promise<RequestArgs>
    - summary
      Reports playback progress within a session.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional playbackProgressInfo: PlaybackProgressInfo
      - options: any = {}
      Returns Promise<RequestArgs>
- reportPlaybackStart: (playbackStartInfo?: PlaybackStartInfo, options?: any) => Promise<RequestArgs>
  - - (playbackStartInfo?: PlaybackStartInfo, options?: any): Promise<RequestArgs>
    - summary
      Reports playback has started within a session.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional playbackStartInfo: PlaybackStartInfo
      - options: any = {}
      Returns Promise<RequestArgs>
- reportPlaybackStopped: (playbackStopInfo?: PlaybackStopInfo, options?: any) => Promise<RequestArgs>
  - - (playbackStopInfo?: PlaybackStopInfo, options?: any): Promise<RequestArgs>
    - summary
      Reports playback has stopped within a session.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional playbackStopInfo: PlaybackStopInfo
      - options: any = {}
      Returns Promise<RequestArgs>

Const PlaystateApiFactory

PlaystateApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { markPlayedItem: any; markUnplayedItem: any; onPlaybackProgress: any; onPlaybackStart: any; onPlaybackStopped: any; pingPlaybackSession: any; reportPlaybackProgress: any; reportPlaybackStart: any; reportPlaybackStopped: any }

- Defined in generated-client/api/playstate-api.ts:664
PlaystateApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { markPlayedItem: any; markUnplayedItem: any; onPlaybackProgress: any; onPlaybackStart: any; onPlaybackStopped: any; pingPlaybackSession: any; reportPlaybackProgress: any; reportPlaybackStart: any; reportPlaybackStopped: any }
- markPlayedItem:function
  - markPlayedItem(userId: string, itemId: string, datePlayed?: string, options?: any): AxiosPromise<UserItemDataDto>
  - - Defined in generated-client/api/playstate-api.ts:676
    summary
    Marks an item as played for user.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional datePlayed: string
    - Optional options: any
    Returns AxiosPromise<UserItemDataDto>
- markUnplayedItem:function
  - markUnplayedItem(userId: string, itemId: string, options?: any): AxiosPromise<UserItemDataDto>
  - - Defined in generated-client/api/playstate-api.ts:687
    summary
    Marks an item as unplayed for user.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional options: any
    Returns AxiosPromise<UserItemDataDto>
- onPlaybackProgress:function
  - onPlaybackProgress(userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/playstate-api.ts:709
    summary
    Reports a user's playback progress.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional mediaSourceId: string
    - Optional positionTicks: number
    - Optional audioStreamIndex: number
    - Optional subtitleStreamIndex: number
    - Optional volumeLevel: number
    - Optional playMethod: PlayMethod
    - Optional liveStreamId: string
    - Optional playSessionId: string
    - Optional repeatMode: RepeatMode
    - Optional isPaused: boolean
    - Optional isMuted: boolean
    - Optional options: any
    Returns AxiosPromise<void>
- onPlaybackStart:function
  - onPlaybackStart(userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/playstate-api.ts:727
    summary
    Reports that a user has begun playing an item.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional mediaSourceId: string
    - Optional audioStreamIndex: number
    - Optional subtitleStreamIndex: number
    - Optional playMethod: PlayMethod
    - Optional liveStreamId: string
    - Optional playSessionId: string
    - Optional canSeek: boolean
    - Optional options: any
    Returns AxiosPromise<void>
- onPlaybackStopped:function
  - onPlaybackStopped(userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/playstate-api.ts:743
    summary
    Reports that a user has stopped playing an item.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional mediaSourceId: string
    - Optional nextMediaType: string
    - Optional positionTicks: number
    - Optional liveStreamId: string
    - Optional playSessionId: string
    - Optional options: any
    Returns AxiosPromise<void>
- pingPlaybackSession:function
  - pingPlaybackSession(playSessionId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/playstate-api.ts:753
    summary
    Pings a playback session.
    
    throws
    {RequiredError}
    
    Parameters
    - playSessionId: string
      Playback session id.
    - Optional options: any
    Returns AxiosPromise<void>
- reportPlaybackProgress:function
  - reportPlaybackProgress(playbackProgressInfo?: PlaybackProgressInfo, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/playstate-api.ts:763
    summary
    Reports playback progress within a session.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional playbackProgressInfo: PlaybackProgressInfo
    - Optional options: any
    Returns AxiosPromise<void>
- reportPlaybackStart:function
  - reportPlaybackStart(playbackStartInfo?: PlaybackStartInfo, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/playstate-api.ts:773
    summary
    Reports playback has started within a session.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional playbackStartInfo: PlaybackStartInfo
    - Optional options: any
    Returns AxiosPromise<void>
- reportPlaybackStopped:function
  - reportPlaybackStopped(playbackStopInfo?: PlaybackStopInfo, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/playstate-api.ts:783
    summary
    Reports playback has stopped within a session.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional playbackStopInfo: PlaybackStopInfo
    - Optional options: any
    Returns AxiosPromise<void>

Const PlaystateApiFp

PlaystateApiFp(configuration?: Configuration): { markPlayedItem: any; markUnplayedItem: any; onPlaybackProgress: any; onPlaybackStart: any; onPlaybackStopped: any; pingPlaybackSession: any; reportPlaybackProgress: any; reportPlaybackStart: any; reportPlaybackStopped: any }

- Defined in generated-client/api/playstate-api.ts:526
PlaystateApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { markPlayedItem: any; markUnplayedItem: any; onPlaybackProgress: any; onPlaybackStart: any; onPlaybackStopped: any; pingPlaybackSession: any; reportPlaybackProgress: any; reportPlaybackStart: any; reportPlaybackStopped: any }
- markPlayedItem:function
  - markPlayedItem(userId: string, itemId: string, datePlayed?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
  - - Defined in generated-client/api/playstate-api.ts:538
    summary
    Marks an item as played for user.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional datePlayed: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
- markUnplayedItem:function
  - markUnplayedItem(userId: string, itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
  - - Defined in generated-client/api/playstate-api.ts:550
    summary
    Marks an item as unplayed for user.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
- onPlaybackProgress:function
  - onPlaybackProgress(userId: string, itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/playstate-api.ts:573
    summary
    Reports a user's playback progress.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional mediaSourceId: string
    - Optional positionTicks: number
    - Optional audioStreamIndex: number
    - Optional subtitleStreamIndex: number
    - Optional volumeLevel: number
    - Optional playMethod: PlayMethod
    - Optional liveStreamId: string
    - Optional playSessionId: string
    - Optional repeatMode: RepeatMode
    - Optional isPaused: boolean
    - Optional isMuted: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- onPlaybackStart:function
  - onPlaybackStart(userId: string, itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/playstate-api.ts:592
    summary
    Reports that a user has begun playing an item.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional mediaSourceId: string
    - Optional audioStreamIndex: number
    - Optional subtitleStreamIndex: number
    - Optional playMethod: PlayMethod
    - Optional liveStreamId: string
    - Optional playSessionId: string
    - Optional canSeek: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- onPlaybackStopped:function
  - onPlaybackStopped(userId: string, itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/playstate-api.ts:609
    summary
    Reports that a user has stopped playing an item.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional mediaSourceId: string
    - Optional nextMediaType: string
    - Optional positionTicks: number
    - Optional liveStreamId: string
    - Optional playSessionId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- pingPlaybackSession:function
  - pingPlaybackSession(playSessionId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/playstate-api.ts:620
    summary
    Pings a playback session.
    
    throws
    {RequiredError}
    
    Parameters
    - playSessionId: string
      Playback session id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- reportPlaybackProgress:function
  - reportPlaybackProgress(playbackProgressInfo?: PlaybackProgressInfo, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/playstate-api.ts:631
    summary
    Reports playback progress within a session.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional playbackProgressInfo: PlaybackProgressInfo
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- reportPlaybackStart:function
  - reportPlaybackStart(playbackStartInfo?: PlaybackStartInfo, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/playstate-api.ts:642
    summary
    Reports playback has started within a session.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional playbackStartInfo: PlaybackStartInfo
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- reportPlaybackStopped:function
  - reportPlaybackStopped(playbackStopInfo?: PlaybackStopInfo, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/playstate-api.ts:653
    summary
    Reports playback has stopped within a session.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional playbackStopInfo: PlaybackStopInfo
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const PluginsApiAxiosParamCreator

PluginsApiAxiosParamCreator(configuration?: Configuration): { disablePlugin: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>; enablePlugin: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>; getPluginConfiguration: (pluginId: string, options?: any) => Promise<RequestArgs>; getPluginImage: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>; getPluginManifest: (pluginId: string, options?: any) => Promise<RequestArgs>; getPlugins: (options?: any) => Promise<RequestArgs>; uninstallPlugin: (pluginId: string, options?: any) => Promise<RequestArgs>; uninstallPluginByVersion: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>; updatePluginConfiguration: (pluginId: string, options?: any) => Promise<RequestArgs>; updatePluginSecurityInfo: (pluginSecurityInfo: PluginSecurityInfo, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/plugins-api.ts:35
PluginsApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { disablePlugin: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>; enablePlugin: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>; getPluginConfiguration: (pluginId: string, options?: any) => Promise<RequestArgs>; getPluginImage: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>; getPluginManifest: (pluginId: string, options?: any) => Promise<RequestArgs>; getPlugins: (options?: any) => Promise<RequestArgs>; uninstallPlugin: (pluginId: string, options?: any) => Promise<RequestArgs>; uninstallPluginByVersion: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>; updatePluginConfiguration: (pluginId: string, options?: any) => Promise<RequestArgs>; updatePluginSecurityInfo: (pluginSecurityInfo: PluginSecurityInfo, options?: any) => Promise<RequestArgs> }
- disablePlugin: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>
  - - (pluginId: string, version: Version, options?: any): Promise<RequestArgs>
    - summary
      Disable a plugin.
      
      throws
      {RequiredError}
      
      Parameters
      - pluginId: string
        Plugin id.
      - version: Version
        Plugin version.
      - options: any = {}
      Returns Promise<RequestArgs>
- enablePlugin: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>
  - - (pluginId: string, version: Version, options?: any): Promise<RequestArgs>
    - summary
      Enables a disabled plugin.
      
      throws
      {RequiredError}
      
      Parameters
      - pluginId: string
        Plugin id.
      - version: Version
        Plugin version.
      - options: any = {}
      Returns Promise<RequestArgs>
- getPluginConfiguration: (pluginId: string, options?: any) => Promise<RequestArgs>
  - - (pluginId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets plugin configuration.
      
      throws
      {RequiredError}
      
      Parameters
      - pluginId: string
        Plugin id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getPluginImage: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>
  - - (pluginId: string, version: Version, options?: any): Promise<RequestArgs>
    - summary
      Gets a plugin's image.
      
      throws
      {RequiredError}
      
      Parameters
      - pluginId: string
        Plugin id.
      - version: Version
        Plugin version.
      - options: any = {}
      Returns Promise<RequestArgs>
- getPluginManifest: (pluginId: string, options?: any) => Promise<RequestArgs>
  - - (pluginId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a plugin's manifest.
      
      throws
      {RequiredError}
      
      Parameters
      - pluginId: string
        Plugin id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getPlugins: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets a list of currently installed plugins.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- uninstallPlugin: (pluginId: string, options?: any) => Promise<RequestArgs>
  - - (pluginId: string, options?: any): Promise<RequestArgs>
    - summary
      Uninstalls a plugin.
      
      deprecated
      throws
      {RequiredError}
      
      Parameters
      - pluginId: string
        Plugin id.
      - options: any = {}
      Returns Promise<RequestArgs>
- uninstallPluginByVersion: (pluginId: string, version: Version, options?: any) => Promise<RequestArgs>
  - - (pluginId: string, version: Version, options?: any): Promise<RequestArgs>
    - summary
      Uninstalls a plugin by version.
      
      throws
      {RequiredError}
      
      Parameters
      - pluginId: string
        Plugin id.
      - version: Version
        Plugin version.
      - options: any = {}
      Returns Promise<RequestArgs>
- updatePluginConfiguration: (pluginId: string, options?: any) => Promise<RequestArgs>
  - - (pluginId: string, options?: any): Promise<RequestArgs>
    - Accepts plugin configuration as JSON body.
      
      summary
      Updates plugin configuration.
      
      throws
      {RequiredError}
      
      Parameters
      - pluginId: string
        Plugin id.
      - options: any = {}
      Returns Promise<RequestArgs>
- updatePluginSecurityInfo: (pluginSecurityInfo: PluginSecurityInfo, options?: any) => Promise<RequestArgs>
  - - (pluginSecurityInfo: PluginSecurityInfo, options?: any): Promise<RequestArgs>
    - summary
      Updates plugin security info.
      
      deprecated
      throws
      {RequiredError}
      
      Parameters
      - pluginSecurityInfo: PluginSecurityInfo
        Plugin security info.
      - options: any = {}
      Returns Promise<RequestArgs>

Const PluginsApiFactory

PluginsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { disablePlugin: any; enablePlugin: any; getPluginConfiguration: any; getPluginImage: any; getPluginManifest: any; getPlugins: any; uninstallPlugin: any; uninstallPluginByVersion: any; updatePluginConfiguration: any; updatePluginSecurityInfo: any }

- Defined in generated-client/api/plugins-api.ts:555
PluginsApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { disablePlugin: any; enablePlugin: any; getPluginConfiguration: any; getPluginImage: any; getPluginManifest: any; getPlugins: any; uninstallPlugin: any; uninstallPluginByVersion: any; updatePluginConfiguration: any; updatePluginSecurityInfo: any }
- disablePlugin:function
  - disablePlugin(pluginId: string, version: Version, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/plugins-api.ts:566
    summary
    Disable a plugin.
    
    throws
    {RequiredError}
    
    Parameters
    - pluginId: string
      Plugin id.
    - version: Version
      Plugin version.
    - Optional options: any
    Returns AxiosPromise<void>
- enablePlugin:function
  - enablePlugin(pluginId: string, version: Version, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/plugins-api.ts:577
    summary
    Enables a disabled plugin.
    
    throws
    {RequiredError}
    
    Parameters
    - pluginId: string
      Plugin id.
    - version: Version
      Plugin version.
    - Optional options: any
    Returns AxiosPromise<void>
- getPluginConfiguration:function
  - getPluginConfiguration(pluginId: string, options?: any): AxiosPromise<object>
  - - Defined in generated-client/api/plugins-api.ts:587
    summary
    Gets plugin configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - pluginId: string
      Plugin id.
    - Optional options: any
    Returns AxiosPromise<object>
- getPluginImage:function
  - getPluginImage(pluginId: string, version: Version, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/plugins-api.ts:598
    summary
    Gets a plugin's image.
    
    throws
    {RequiredError}
    
    Parameters
    - pluginId: string
      Plugin id.
    - version: Version
      Plugin version.
    - Optional options: any
    Returns AxiosPromise<any>
- getPluginManifest:function
  - getPluginManifest(pluginId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/plugins-api.ts:608
    summary
    Gets a plugin's manifest.
    
    throws
    {RequiredError}
    
    Parameters
    - pluginId: string
      Plugin id.
    - Optional options: any
    Returns AxiosPromise<void>
- getPlugins:function
  - getPlugins(options?: any): AxiosPromise<PluginInfo[]>
  - - Defined in generated-client/api/plugins-api.ts:617
    summary
    Gets a list of currently installed plugins.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<PluginInfo[]>
- uninstallPlugin:function
  - uninstallPlugin(pluginId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/plugins-api.ts:628
    summary
    Uninstalls a plugin.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - pluginId: string
      Plugin id.
    - Optional options: any
    Returns AxiosPromise<void>
- uninstallPluginByVersion:function
  - uninstallPluginByVersion(pluginId: string, version: Version, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/plugins-api.ts:639
    summary
    Uninstalls a plugin by version.
    
    throws
    {RequiredError}
    
    Parameters
    - pluginId: string
      Plugin id.
    - version: Version
      Plugin version.
    - Optional options: any
    Returns AxiosPromise<void>
- updatePluginConfiguration:function
  - updatePluginConfiguration(pluginId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/plugins-api.ts:649
    Accepts plugin configuration as JSON body.
    
    summary
    Updates plugin configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - pluginId: string
      Plugin id.
    - Optional options: any
    Returns AxiosPromise<void>
- updatePluginSecurityInfo:function
  - updatePluginSecurityInfo(pluginSecurityInfo: PluginSecurityInfo, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/plugins-api.ts:660
    summary
    Updates plugin security info.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - pluginSecurityInfo: PluginSecurityInfo
      Plugin security info.
    - Optional options: any
    Returns AxiosPromise<void>

Const PluginsApiFp

PluginsApiFp(configuration?: Configuration): { disablePlugin: any; enablePlugin: any; getPluginConfiguration: any; getPluginImage: any; getPluginManifest: any; getPlugins: any; uninstallPlugin: any; uninstallPluginByVersion: any; updatePluginConfiguration: any; updatePluginSecurityInfo: any }

- Defined in generated-client/api/plugins-api.ts:430
PluginsApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { disablePlugin: any; enablePlugin: any; getPluginConfiguration: any; getPluginImage: any; getPluginManifest: any; getPlugins: any; uninstallPlugin: any; uninstallPluginByVersion: any; updatePluginConfiguration: any; updatePluginSecurityInfo: any }
- disablePlugin:function
  - disablePlugin(pluginId: string, version: Version, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/plugins-api.ts:441
    summary
    Disable a plugin.
    
    throws
    {RequiredError}
    
    Parameters
    - pluginId: string
      Plugin id.
    - version: Version
      Plugin version.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- enablePlugin:function
  - enablePlugin(pluginId: string, version: Version, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/plugins-api.ts:453
    summary
    Enables a disabled plugin.
    
    throws
    {RequiredError}
    
    Parameters
    - pluginId: string
      Plugin id.
    - version: Version
      Plugin version.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getPluginConfiguration:function
  - getPluginConfiguration(pluginId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
  - - Defined in generated-client/api/plugins-api.ts:464
    summary
    Gets plugin configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - pluginId: string
      Plugin id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>
- getPluginImage:function
  - getPluginImage(pluginId: string, version: Version, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/plugins-api.ts:476
    summary
    Gets a plugin's image.
    
    throws
    {RequiredError}
    
    Parameters
    - pluginId: string
      Plugin id.
    - version: Version
      Plugin version.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getPluginManifest:function
  - getPluginManifest(pluginId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/plugins-api.ts:487
    summary
    Gets a plugin's manifest.
    
    throws
    {RequiredError}
    
    Parameters
    - pluginId: string
      Plugin id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getPlugins:function
  - getPlugins(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PluginInfo[]>>
  - - Defined in generated-client/api/plugins-api.ts:497
    summary
    Gets a list of currently installed plugins.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PluginInfo[]>>
- uninstallPlugin:function
  - uninstallPlugin(pluginId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/plugins-api.ts:509
    summary
    Uninstalls a plugin.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - pluginId: string
      Plugin id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- uninstallPluginByVersion:function
  - uninstallPluginByVersion(pluginId: string, version: Version, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/plugins-api.ts:521
    summary
    Uninstalls a plugin by version.
    
    throws
    {RequiredError}
    
    Parameters
    - pluginId: string
      Plugin id.
    - version: Version
      Plugin version.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- updatePluginConfiguration:function
  - updatePluginConfiguration(pluginId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/plugins-api.ts:532
    Accepts plugin configuration as JSON body.
    
    summary
    Updates plugin configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - pluginId: string
      Plugin id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- updatePluginSecurityInfo:function
  - updatePluginSecurityInfo(pluginSecurityInfo: PluginSecurityInfo, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/plugins-api.ts:544
    summary
    Updates plugin security info.
    
    deprecated
    throws
    {RequiredError}
    
    Parameters
    - pluginSecurityInfo: PluginSecurityInfo
      Plugin security info.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const QuickConnectApiAxiosParamCreator

QuickConnectApiAxiosParamCreator(configuration?: Configuration): { activate: (options?: any) => Promise<RequestArgs>; authorize: (code: string, options?: any) => Promise<RequestArgs>; available: (status?: QuickConnectState, options?: any) => Promise<RequestArgs>; connect: (secret: string, options?: any) => Promise<RequestArgs>; deauthorize: (options?: any) => Promise<RequestArgs>; getStatus: (options?: any) => Promise<RequestArgs>; initiate: (options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/quick-connect-api.ts:33
QuickConnectApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { activate: (options?: any) => Promise<RequestArgs>; authorize: (code: string, options?: any) => Promise<RequestArgs>; available: (status?: QuickConnectState, options?: any) => Promise<RequestArgs>; connect: (secret: string, options?: any) => Promise<RequestArgs>; deauthorize: (options?: any) => Promise<RequestArgs>; getStatus: (options?: any) => Promise<RequestArgs>; initiate: (options?: any) => Promise<RequestArgs> }
- activate: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Temporarily activates quick connect for five minutes.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- authorize: (code: string, options?: any) => Promise<RequestArgs>
  - - (code: string, options?: any): Promise<RequestArgs>
    - summary
      Authorizes a pending quick connect request.
      
      throws
      {RequiredError}
      
      Parameters
      - code: string
        Quick connect code to authorize.
      - options: any = {}
      Returns Promise<RequestArgs>
- available: (status?: QuickConnectState, options?: any) => Promise<RequestArgs>
  - - (status?: QuickConnectState, options?: any): Promise<RequestArgs>
    - summary
      Enables or disables quick connect.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional status: QuickConnectState
      - options: any = {}
      Returns Promise<RequestArgs>
- connect: (secret: string, options?: any) => Promise<RequestArgs>
  - - (secret: string, options?: any): Promise<RequestArgs>
    - summary
      Attempts to retrieve authentication information.
      
      throws
      {RequiredError}
      
      Parameters
      - secret: string
        Secret previously returned from the Initiate endpoint.
      - options: any = {}
      Returns Promise<RequestArgs>
- deauthorize: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Deauthorize all quick connect devices for the current user.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getStatus: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets the current quick connect state.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- initiate: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Initiate a new quick connect request.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>

Const QuickConnectApiFactory

QuickConnectApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { activate: any; authorize: any; available: any; connect: any; deauthorize: any; getStatus: any; initiate: any }

- Defined in generated-client/api/quick-connect-api.ts:366
QuickConnectApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { activate: any; authorize: any; available: any; connect: any; deauthorize: any; getStatus: any; initiate: any }
- activate:function
  - activate(options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/quick-connect-api.ts:375
    summary
    Temporarily activates quick connect for five minutes.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<void>
- authorize:function
  - authorize(code: string, options?: any): AxiosPromise<boolean>
  - - Defined in generated-client/api/quick-connect-api.ts:385
    summary
    Authorizes a pending quick connect request.
    
    throws
    {RequiredError}
    
    Parameters
    - code: string
      Quick connect code to authorize.
    - Optional options: any
    Returns AxiosPromise<boolean>
- available:function
  - available(status?: QuickConnectState, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/quick-connect-api.ts:395
    summary
    Enables or disables quick connect.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional status: QuickConnectState
    - Optional options: any
    Returns AxiosPromise<void>
- connect:function
  - connect(secret: string, options?: any): AxiosPromise<QuickConnectResult>
  - - Defined in generated-client/api/quick-connect-api.ts:405
    summary
    Attempts to retrieve authentication information.
    
    throws
    {RequiredError}
    
    Parameters
    - secret: string
      Secret previously returned from the Initiate endpoint.
    - Optional options: any
    Returns AxiosPromise<QuickConnectResult>
- deauthorize:function
  - deauthorize(options?: any): AxiosPromise<number>
  - - Defined in generated-client/api/quick-connect-api.ts:414
    summary
    Deauthorize all quick connect devices for the current user.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<number>
- getStatus:function
  - getStatus(options?: any): AxiosPromise<QuickConnectState>
  - - Defined in generated-client/api/quick-connect-api.ts:423
    summary
    Gets the current quick connect state.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<QuickConnectState>
- initiate:function
  - initiate(options?: any): AxiosPromise<QuickConnectResult>
  - - Defined in generated-client/api/quick-connect-api.ts:432
    summary
    Initiate a new quick connect request.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<QuickConnectResult>

Const QuickConnectApiFp

QuickConnectApiFp(configuration?: Configuration): { activate: any; authorize: any; available: any; connect: any; deauthorize: any; getStatus: any; initiate: any }

- Defined in generated-client/api/quick-connect-api.ts:283
QuickConnectApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { activate: any; authorize: any; available: any; connect: any; deauthorize: any; getStatus: any; initiate: any }
- activate:function
  - activate(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/quick-connect-api.ts:292
    summary
    Temporarily activates quick connect for five minutes.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- authorize:function
  - authorize(code: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>
  - - Defined in generated-client/api/quick-connect-api.ts:303
    summary
    Authorizes a pending quick connect request.
    
    throws
    {RequiredError}
    
    Parameters
    - code: string
      Quick connect code to authorize.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>>
- available:function
  - available(status?: QuickConnectState, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/quick-connect-api.ts:314
    summary
    Enables or disables quick connect.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional status: QuickConnectState
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- connect:function
  - connect(secret: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>>
  - - Defined in generated-client/api/quick-connect-api.ts:325
    summary
    Attempts to retrieve authentication information.
    
    throws
    {RequiredError}
    
    Parameters
    - secret: string
      Secret previously returned from the Initiate endpoint.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>>
- deauthorize:function
  - deauthorize(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<number>>
  - - Defined in generated-client/api/quick-connect-api.ts:335
    summary
    Deauthorize all quick connect devices for the current user.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<number>>
- getStatus:function
  - getStatus(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectState>>
  - - Defined in generated-client/api/quick-connect-api.ts:345
    summary
    Gets the current quick connect state.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectState>>
- initiate:function
  - initiate(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>>
  - - Defined in generated-client/api/quick-connect-api.ts:355
    summary
    Initiate a new quick connect request.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuickConnectResult>>

Const RemoteImageApiAxiosParamCreator

RemoteImageApiAxiosParamCreator(configuration?: Configuration): { downloadRemoteImage: (itemId: string, type: ImageType, imageUrl?: string, options?: any) => Promise<RequestArgs>; getRemoteImageProviders: (itemId: string, options?: any) => Promise<RequestArgs>; getRemoteImages: (itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/remote-image-api.ts:35
RemoteImageApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { downloadRemoteImage: (itemId: string, type: ImageType, imageUrl?: string, options?: any) => Promise<RequestArgs>; getRemoteImageProviders: (itemId: string, options?: any) => Promise<RequestArgs>; getRemoteImages: (itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: any) => Promise<RequestArgs> }
- downloadRemoteImage: (itemId: string, type: ImageType, imageUrl?: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, type: ImageType, imageUrl?: string, options?: any): Promise<RequestArgs>
    - summary
      Downloads a remote image for an item.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item Id.
      - type: ImageType
        The image type.
      - Optional imageUrl: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getRemoteImageProviders: (itemId: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets available remote image providers for an item.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item Id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getRemoteImages: (itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: any) => Promise<RequestArgs>
  - - (itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets available remote images for an item.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        Item Id.
      - Optional type: ImageType
      - Optional startIndex: number
      - Optional limit: number
      - Optional providerName: string
      - Optional includeAllLanguages: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const RemoteImageApiFactory

RemoteImageApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { downloadRemoteImage: any; getRemoteImageProviders: any; getRemoteImages: any }

- Defined in generated-client/api/remote-image-api.ts:242
RemoteImageApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { downloadRemoteImage: any; getRemoteImageProviders: any; getRemoteImages: any }
- downloadRemoteImage:function
  - downloadRemoteImage(itemId: string, type: ImageType, imageUrl?: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/remote-image-api.ts:254
    summary
    Downloads a remote image for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item Id.
    - type: ImageType
      The image type.
    - Optional imageUrl: string
    - Optional options: any
    Returns AxiosPromise<void>
- getRemoteImageProviders:function
  - getRemoteImageProviders(itemId: string, options?: any): AxiosPromise<ImageProviderInfo[]>
  - - Defined in generated-client/api/remote-image-api.ts:264
    summary
    Gets available remote image providers for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item Id.
    - Optional options: any
    Returns AxiosPromise<ImageProviderInfo[]>
- getRemoteImages:function
  - getRemoteImages(itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: any): AxiosPromise<RemoteImageResult>
  - - Defined in generated-client/api/remote-image-api.ts:279
    summary
    Gets available remote images for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item Id.
    - Optional type: ImageType
    - Optional startIndex: number
    - Optional limit: number
    - Optional providerName: string
    - Optional includeAllLanguages: boolean
    - Optional options: any
    Returns AxiosPromise<RemoteImageResult>

Const RemoteImageApiFp

RemoteImageApiFp(configuration?: Configuration): { downloadRemoteImage: any; getRemoteImageProviders: any; getRemoteImages: any }

- Defined in generated-client/api/remote-image-api.ts:192
RemoteImageApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { downloadRemoteImage: any; getRemoteImageProviders: any; getRemoteImages: any }
- downloadRemoteImage:function
  - downloadRemoteImage(itemId: string, type: ImageType, imageUrl?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/remote-image-api.ts:204
    summary
    Downloads a remote image for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item Id.
    - type: ImageType
      The image type.
    - Optional imageUrl: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getRemoteImageProviders:function
  - getRemoteImageProviders(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageProviderInfo[]>>
  - - Defined in generated-client/api/remote-image-api.ts:215
    summary
    Gets available remote image providers for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item Id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImageProviderInfo[]>>
- getRemoteImages:function
  - getRemoteImages(itemId: string, type?: ImageType, startIndex?: number, limit?: number, providerName?: string, includeAllLanguages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteImageResult>>
  - - Defined in generated-client/api/remote-image-api.ts:231
    summary
    Gets available remote images for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      Item Id.
    - Optional type: ImageType
    - Optional startIndex: number
    - Optional limit: number
    - Optional providerName: string
    - Optional includeAllLanguages: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteImageResult>>

Const ScheduledTasksApiAxiosParamCreator

ScheduledTasksApiAxiosParamCreator(configuration?: Configuration): { getTask: (taskId: string, options?: any) => Promise<RequestArgs>; getTasks: (isHidden?: boolean, isEnabled?: boolean, options?: any) => Promise<RequestArgs>; startTask: (taskId: string, options?: any) => Promise<RequestArgs>; stopTask: (taskId: string, options?: any) => Promise<RequestArgs>; updateTask: (taskId: string, taskTriggerInfo: TaskTriggerInfo[], options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/scheduled-tasks-api.ts:33
ScheduledTasksApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getTask: (taskId: string, options?: any) => Promise<RequestArgs>; getTasks: (isHidden?: boolean, isEnabled?: boolean, options?: any) => Promise<RequestArgs>; startTask: (taskId: string, options?: any) => Promise<RequestArgs>; stopTask: (taskId: string, options?: any) => Promise<RequestArgs>; updateTask: (taskId: string, taskTriggerInfo: TaskTriggerInfo[], options?: any) => Promise<RequestArgs> }
- getTask: (taskId: string, options?: any) => Promise<RequestArgs>
  - - (taskId: string, options?: any): Promise<RequestArgs>
    - summary
      Get task by id.
      
      throws
      {RequiredError}
      
      Parameters
      - taskId: string
        Task Id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getTasks: (isHidden?: boolean, isEnabled?: boolean, options?: any) => Promise<RequestArgs>
  - - (isHidden?: boolean, isEnabled?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Get tasks.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional isHidden: boolean
      - Optional isEnabled: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- startTask: (taskId: string, options?: any) => Promise<RequestArgs>
  - - (taskId: string, options?: any): Promise<RequestArgs>
    - summary
      Start specified task.
      
      throws
      {RequiredError}
      
      Parameters
      - taskId: string
        Task Id.
      - options: any = {}
      Returns Promise<RequestArgs>
- stopTask: (taskId: string, options?: any) => Promise<RequestArgs>
  - - (taskId: string, options?: any): Promise<RequestArgs>
    - summary
      Stop specified task.
      
      throws
      {RequiredError}
      
      Parameters
      - taskId: string
        Task Id.
      - options: any = {}
      Returns Promise<RequestArgs>
- updateTask: (taskId: string, taskTriggerInfo: TaskTriggerInfo[], options?: any) => Promise<RequestArgs>
  - - (taskId: string, taskTriggerInfo: TaskTriggerInfo[], options?: any): Promise<RequestArgs>
    - summary
      Update specified task triggers.
      
      throws
      {RequiredError}
      
      Parameters
      - taskId: string
        Task Id.
      - taskTriggerInfo: TaskTriggerInfo[]
        Triggers.
      - options: any = {}
      Returns Promise<RequestArgs>

Const ScheduledTasksApiFactory

ScheduledTasksApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getTask: any; getTasks: any; startTask: any; stopTask: any; updateTask: any }

- Defined in generated-client/api/scheduled-tasks-api.ts:306
ScheduledTasksApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getTask: any; getTasks: any; startTask: any; stopTask: any; updateTask: any }
- getTask:function
  - getTask(taskId: string, options?: any): AxiosPromise<TaskInfo>
  - - Defined in generated-client/api/scheduled-tasks-api.ts:316
    summary
    Get task by id.
    
    throws
    {RequiredError}
    
    Parameters
    - taskId: string
      Task Id.
    - Optional options: any
    Returns AxiosPromise<TaskInfo>
- getTasks:function
  - getTasks(isHidden?: boolean, isEnabled?: boolean, options?: any): AxiosPromise<TaskInfo[]>
  - - Defined in generated-client/api/scheduled-tasks-api.ts:327
    summary
    Get tasks.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional isHidden: boolean
    - Optional isEnabled: boolean
    - Optional options: any
    Returns AxiosPromise<TaskInfo[]>
- startTask:function
  - startTask(taskId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/scheduled-tasks-api.ts:337
    summary
    Start specified task.
    
    throws
    {RequiredError}
    
    Parameters
    - taskId: string
      Task Id.
    - Optional options: any
    Returns AxiosPromise<void>
- stopTask:function
  - stopTask(taskId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/scheduled-tasks-api.ts:347
    summary
    Stop specified task.
    
    throws
    {RequiredError}
    
    Parameters
    - taskId: string
      Task Id.
    - Optional options: any
    Returns AxiosPromise<void>
- updateTask:function
  - updateTask(taskId: string, taskTriggerInfo: TaskTriggerInfo[], options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/scheduled-tasks-api.ts:358
    summary
    Update specified task triggers.
    
    throws
    {RequiredError}
    
    Parameters
    - taskId: string
      Task Id.
    - taskTriggerInfo: TaskTriggerInfo[]
      Triggers.
    - Optional options: any
    Returns AxiosPromise<void>

Const ScheduledTasksApiFp

ScheduledTasksApiFp(configuration?: Configuration): { getTask: any; getTasks: any; startTask: any; stopTask: any; updateTask: any }

- Defined in generated-client/api/scheduled-tasks-api.ts:239
ScheduledTasksApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getTask: any; getTasks: any; startTask: any; stopTask: any; updateTask: any }
- getTask:function
  - getTask(taskId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskInfo>>
  - - Defined in generated-client/api/scheduled-tasks-api.ts:249
    summary
    Get task by id.
    
    throws
    {RequiredError}
    
    Parameters
    - taskId: string
      Task Id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskInfo>>
- getTasks:function
  - getTasks(isHidden?: boolean, isEnabled?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskInfo[]>>
  - - Defined in generated-client/api/scheduled-tasks-api.ts:261
    summary
    Get tasks.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional isHidden: boolean
    - Optional isEnabled: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TaskInfo[]>>
- startTask:function
  - startTask(taskId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/scheduled-tasks-api.ts:272
    summary
    Start specified task.
    
    throws
    {RequiredError}
    
    Parameters
    - taskId: string
      Task Id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- stopTask:function
  - stopTask(taskId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/scheduled-tasks-api.ts:283
    summary
    Stop specified task.
    
    throws
    {RequiredError}
    
    Parameters
    - taskId: string
      Task Id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- updateTask:function
  - updateTask(taskId: string, taskTriggerInfo: TaskTriggerInfo[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/scheduled-tasks-api.ts:295
    summary
    Update specified task triggers.
    
    throws
    {RequiredError}
    
    Parameters
    - taskId: string
      Task Id.
    - taskTriggerInfo: TaskTriggerInfo[]
      Triggers.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const SearchApiAxiosParamCreator

SearchApiAxiosParamCreator(configuration?: Configuration): { get: (searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: string[], excludeItemTypes?: string[], mediaTypes?: string[], parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/search-api.ts:29
SearchApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { get: (searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: string[], excludeItemTypes?: string[], mediaTypes?: string[], parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: any) => Promise<RequestArgs> }
- get: (searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: string[], excludeItemTypes?: string[], mediaTypes?: string[], parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: any) => Promise<RequestArgs>
  - - (searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: string[], excludeItemTypes?: string[], mediaTypes?: string[], parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets the search hint result.
      
      throws
      {RequiredError}
      
      Parameters
      - searchTerm: string
        The search term to filter on.
      - Optional startIndex: number
      - Optional limit: number
      - Optional userId: string
      - Optional includeItemTypes: string[]
      - Optional excludeItemTypes: string[]
      - Optional mediaTypes: string[]
      - Optional parentId: string
      - Optional isMovie: boolean
      - Optional isSeries: boolean
      - Optional isNews: boolean
      - Optional isKids: boolean
      - Optional isSports: boolean
      - Optional includePeople: boolean
      - Optional includeMedia: boolean
      - Optional includeGenres: boolean
      - Optional includeStudios: boolean
      - Optional includeArtists: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const SearchApiFactory

SearchApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { get: any }

- Defined in generated-client/api/search-api.ts:201
SearchApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { get: any }
- get:function
  - get(searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: string[], excludeItemTypes?: string[], mediaTypes?: string[], parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: any): AxiosPromise<SearchHintResult>
  - - Defined in generated-client/api/search-api.ts:228
    summary
    Gets the search hint result.
    
    throws
    {RequiredError}
    
    Parameters
    - searchTerm: string
      The search term to filter on.
    - Optional startIndex: number
    - Optional limit: number
    - Optional userId: string
    - Optional includeItemTypes: string[]
    - Optional excludeItemTypes: string[]
    - Optional mediaTypes: string[]
    - Optional parentId: string
    - Optional isMovie: boolean
    - Optional isSeries: boolean
    - Optional isNews: boolean
    - Optional isKids: boolean
    - Optional isSports: boolean
    - Optional includePeople: boolean
    - Optional includeMedia: boolean
    - Optional includeGenres: boolean
    - Optional includeStudios: boolean
    - Optional includeArtists: boolean
    - Optional options: any
    Returns AxiosPromise<SearchHintResult>

Const SearchApiFp

SearchApiFp(configuration?: Configuration): { get: any }

- Defined in generated-client/api/search-api.ts:163
SearchApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { get: any }
- get:function
  - get(searchTerm: string, startIndex?: number, limit?: number, userId?: string, includeItemTypes?: string[], excludeItemTypes?: string[], mediaTypes?: string[], parentId?: string, isMovie?: boolean, isSeries?: boolean, isNews?: boolean, isKids?: boolean, isSports?: boolean, includePeople?: boolean, includeMedia?: boolean, includeGenres?: boolean, includeStudios?: boolean, includeArtists?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchHintResult>>
  - - Defined in generated-client/api/search-api.ts:190
    summary
    Gets the search hint result.
    
    throws
    {RequiredError}
    
    Parameters
    - searchTerm: string
      The search term to filter on.
    - Optional startIndex: number
    - Optional limit: number
    - Optional userId: string
    - Optional includeItemTypes: string[]
    - Optional excludeItemTypes: string[]
    - Optional mediaTypes: string[]
    - Optional parentId: string
    - Optional isMovie: boolean
    - Optional isSeries: boolean
    - Optional isNews: boolean
    - Optional isKids: boolean
    - Optional isSports: boolean
    - Optional includePeople: boolean
    - Optional includeMedia: boolean
    - Optional includeGenres: boolean
    - Optional includeStudios: boolean
    - Optional includeArtists: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchHintResult>>

Const SessionApiAxiosParamCreator

SessionApiAxiosParamCreator(configuration?: Configuration): { addUserToSession: (sessionId: string, userId: string, options?: any) => Promise<RequestArgs>; displayContent: (sessionId: string, itemType: string, itemId: string, itemName: string, options?: any) => Promise<RequestArgs>; getAuthProviders: (options?: any) => Promise<RequestArgs>; getPasswordResetProviders: (options?: any) => Promise<RequestArgs>; getSessions: (controllableByUserId?: string, deviceId?: string, activeWithinSeconds?: number, options?: any) => Promise<RequestArgs>; play: (sessionId: string, playCommand: PlayCommand, itemIds: string[], startPositionTicks?: number, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, startIndex?: number, options?: any) => Promise<RequestArgs>; postCapabilities: (id?: string, playableMediaTypes?: string[], supportedCommands?: GeneralCommandType[], supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options?: any) => Promise<RequestArgs>; postFullCapabilities: (clientCapabilitiesDto: ClientCapabilitiesDto, id?: string, options?: any) => Promise<RequestArgs>; removeUserFromSession: (sessionId: string, userId: string, options?: any) => Promise<RequestArgs>; reportSessionEnded: (options?: any) => Promise<RequestArgs>; reportViewing: (itemId: string, sessionId?: string, options?: any) => Promise<RequestArgs>; sendFullGeneralCommand: (sessionId: string, generalCommand: GeneralCommand, options?: any) => Promise<RequestArgs>; sendGeneralCommand: (sessionId: string, command: GeneralCommandType, options?: any) => Promise<RequestArgs>; sendMessageCommand: (sessionId: string, messageCommand: MessageCommand, options?: any) => Promise<RequestArgs>; sendPlaystateCommand: (sessionId: string, command: PlaystateCommand, seekPositionTicks?: number, controllingUserId?: string, options?: any) => Promise<RequestArgs>; sendSystemCommand: (sessionId: string, command: GeneralCommandType, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/session-api.ts:43
SessionApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { addUserToSession: (sessionId: string, userId: string, options?: any) => Promise<RequestArgs>; displayContent: (sessionId: string, itemType: string, itemId: string, itemName: string, options?: any) => Promise<RequestArgs>; getAuthProviders: (options?: any) => Promise<RequestArgs>; getPasswordResetProviders: (options?: any) => Promise<RequestArgs>; getSessions: (controllableByUserId?: string, deviceId?: string, activeWithinSeconds?: number, options?: any) => Promise<RequestArgs>; play: (sessionId: string, playCommand: PlayCommand, itemIds: string[], startPositionTicks?: number, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, startIndex?: number, options?: any) => Promise<RequestArgs>; postCapabilities: (id?: string, playableMediaTypes?: string[], supportedCommands?: GeneralCommandType[], supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options?: any) => Promise<RequestArgs>; postFullCapabilities: (clientCapabilitiesDto: ClientCapabilitiesDto, id?: string, options?: any) => Promise<RequestArgs>; removeUserFromSession: (sessionId: string, userId: string, options?: any) => Promise<RequestArgs>; reportSessionEnded: (options?: any) => Promise<RequestArgs>; reportViewing: (itemId: string, sessionId?: string, options?: any) => Promise<RequestArgs>; sendFullGeneralCommand: (sessionId: string, generalCommand: GeneralCommand, options?: any) => Promise<RequestArgs>; sendGeneralCommand: (sessionId: string, command: GeneralCommandType, options?: any) => Promise<RequestArgs>; sendMessageCommand: (sessionId: string, messageCommand: MessageCommand, options?: any) => Promise<RequestArgs>; sendPlaystateCommand: (sessionId: string, command: PlaystateCommand, seekPositionTicks?: number, controllingUserId?: string, options?: any) => Promise<RequestArgs>; sendSystemCommand: (sessionId: string, command: GeneralCommandType, options?: any) => Promise<RequestArgs> }
- addUserToSession: (sessionId: string, userId: string, options?: any) => Promise<RequestArgs>
  - - (sessionId: string, userId: string, options?: any): Promise<RequestArgs>
    - summary
      Adds an additional user to a session.
      
      throws
      {RequiredError}
      
      Parameters
      - sessionId: string
        The session id.
      - userId: string
        The user id.
      - options: any = {}
      Returns Promise<RequestArgs>
- displayContent: (sessionId: string, itemType: string, itemId: string, itemName: string, options?: any) => Promise<RequestArgs>
  - - (sessionId: string, itemType: string, itemId: string, itemName: string, options?: any): Promise<RequestArgs>
    - summary
      Instructs a session to browse to an item or view.
      
      throws
      {RequiredError}
      
      Parameters
      - sessionId: string
        The session Id.
      - itemType: string
        The type of item to browse to.
      - itemId: string
        The Id of the item.
      - itemName: string
        The name of the item.
      - options: any = {}
      Returns Promise<RequestArgs>
- getAuthProviders: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Get all auth providers.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getPasswordResetProviders: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Get all password reset providers.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getSessions: (controllableByUserId?: string, deviceId?: string, activeWithinSeconds?: number, options?: any) => Promise<RequestArgs>
  - - (controllableByUserId?: string, deviceId?: string, activeWithinSeconds?: number, options?: any): Promise<RequestArgs>
    - summary
      Gets a list of sessions.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional controllableByUserId: string
      - Optional deviceId: string
      - Optional activeWithinSeconds: number
      - options: any = {}
      Returns Promise<RequestArgs>
- play: (sessionId: string, playCommand: PlayCommand, itemIds: string[], startPositionTicks?: number, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, startIndex?: number, options?: any) => Promise<RequestArgs>
  - - (sessionId: string, playCommand: PlayCommand, itemIds: string[], startPositionTicks?: number, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, startIndex?: number, options?: any): Promise<RequestArgs>
    - summary
      Instructs a session to play an item.
      
      throws
      {RequiredError}
      
      Parameters
      - sessionId: string
        The session id.
      - playCommand: PlayCommand
        The type of play command to issue (PlayNow, PlayNext, PlayLast). Clients who have not yet implemented play next and play last may play now.
      - itemIds: string[]
        The ids of the items to play, comma delimited.
      - Optional startPositionTicks: number
      - Optional mediaSourceId: string
      - Optional audioStreamIndex: number
      - Optional subtitleStreamIndex: number
      - Optional startIndex: number
      - options: any = {}
      Returns Promise<RequestArgs>
- postCapabilities: (id?: string, playableMediaTypes?: string[], supportedCommands?: GeneralCommandType[], supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options?: any) => Promise<RequestArgs>
  - - (id?: string, playableMediaTypes?: string[], supportedCommands?: GeneralCommandType[], supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Updates capabilities for a device.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional id: string
      - Optional playableMediaTypes: string[]
      - Optional supportedCommands: GeneralCommandType[]
      - Optional supportsMediaControl: boolean
      - Optional supportsSync: boolean
      - Optional supportsPersistentIdentifier: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- postFullCapabilities: (clientCapabilitiesDto: ClientCapabilitiesDto, id?: string, options?: any) => Promise<RequestArgs>
  - - (clientCapabilitiesDto: ClientCapabilitiesDto, id?: string, options?: any): Promise<RequestArgs>
    - summary
      Updates capabilities for a device.
      
      throws
      {RequiredError}
      
      Parameters
      - clientCapabilitiesDto: ClientCapabilitiesDto
        The MediaBrowser.Model.Session.ClientCapabilities.
      - Optional id: string
      - options: any = {}
      Returns Promise<RequestArgs>
- removeUserFromSession: (sessionId: string, userId: string, options?: any) => Promise<RequestArgs>
  - - (sessionId: string, userId: string, options?: any): Promise<RequestArgs>
    - summary
      Removes an additional user from a session.
      
      throws
      {RequiredError}
      
      Parameters
      - sessionId: string
        The session id.
      - userId: string
        The user id.
      - options: any = {}
      Returns Promise<RequestArgs>
- reportSessionEnded: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Reports that a session has ended.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- reportViewing: (itemId: string, sessionId?: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, sessionId?: string, options?: any): Promise<RequestArgs>
    - summary
      Reports that a session is viewing an item.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional sessionId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- sendFullGeneralCommand: (sessionId: string, generalCommand: GeneralCommand, options?: any) => Promise<RequestArgs>
  - - (sessionId: string, generalCommand: GeneralCommand, options?: any): Promise<RequestArgs>
    - summary
      Issues a full general command to a client.
      
      throws
      {RequiredError}
      
      Parameters
      - sessionId: string
        The session id.
      - generalCommand: GeneralCommand
        The MediaBrowser.Model.Session.GeneralCommand.
      - options: any = {}
      Returns Promise<RequestArgs>
- sendGeneralCommand: (sessionId: string, command: GeneralCommandType, options?: any) => Promise<RequestArgs>
  - - (sessionId: string, command: GeneralCommandType, options?: any): Promise<RequestArgs>
    - summary
      Issues a general command to a client.
      
      throws
      {RequiredError}
      
      Parameters
      - sessionId: string
        The session id.
      - command: GeneralCommandType
        The command to send.
      - options: any = {}
      Returns Promise<RequestArgs>
- sendMessageCommand: (sessionId: string, messageCommand: MessageCommand, options?: any) => Promise<RequestArgs>
  - - (sessionId: string, messageCommand: MessageCommand, options?: any): Promise<RequestArgs>
    - summary
      Issues a command to a client to display a message to the user.
      
      throws
      {RequiredError}
      
      Parameters
      - sessionId: string
        The session id.
      - messageCommand: MessageCommand
        The MediaBrowser.Model.Session.MessageCommand object containing Header, Message Text, and TimeoutMs.
      - options: any = {}
      Returns Promise<RequestArgs>
- sendPlaystateCommand: (sessionId: string, command: PlaystateCommand, seekPositionTicks?: number, controllingUserId?: string, options?: any) => Promise<RequestArgs>
  - - (sessionId: string, command: PlaystateCommand, seekPositionTicks?: number, controllingUserId?: string, options?: any): Promise<RequestArgs>
    - summary
      Issues a playstate command to a client.
      
      throws
      {RequiredError}
      
      Parameters
      - sessionId: string
        The session id.
      - command: PlaystateCommand
        The MediaBrowser.Model.Session.PlaystateCommand.
      - Optional seekPositionTicks: number
      - Optional controllingUserId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- sendSystemCommand: (sessionId: string, command: GeneralCommandType, options?: any) => Promise<RequestArgs>
  - - (sessionId: string, command: GeneralCommandType, options?: any): Promise<RequestArgs>
    - summary
      Issues a system command to a client.
      
      throws
      {RequiredError}
      
      Parameters
      - sessionId: string
        The session id.
      - command: GeneralCommandType
        The command to send.
      - options: any = {}
      Returns Promise<RequestArgs>

Const SessionApiFactory

SessionApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { addUserToSession: any; displayContent: any; getAuthProviders: any; getPasswordResetProviders: any; getSessions: any; play: any; postCapabilities: any; postFullCapabilities: any; removeUserFromSession: any; reportSessionEnded: any; reportViewing: any; sendFullGeneralCommand: any; sendGeneralCommand: any; sendMessageCommand: any; sendPlaystateCommand: any; sendSystemCommand: any }

- Defined in generated-client/api/session-api.ts:997
SessionApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { addUserToSession: any; displayContent: any; getAuthProviders: any; getPasswordResetProviders: any; getSessions: any; play: any; postCapabilities: any; postFullCapabilities: any; removeUserFromSession: any; reportSessionEnded: any; reportViewing: any; sendFullGeneralCommand: any; sendGeneralCommand: any; sendMessageCommand: any; sendPlaystateCommand: any; sendSystemCommand: any }
- addUserToSession:function
  - addUserToSession(sessionId: string, userId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/session-api.ts:1008
    summary
    Adds an additional user to a session.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session id.
    - userId: string
      The user id.
    - Optional options: any
    Returns AxiosPromise<void>
- displayContent:function
  - displayContent(sessionId: string, itemType: string, itemId: string, itemName: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/session-api.ts:1021
    summary
    Instructs a session to browse to an item or view.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session Id.
    - itemType: string
      The type of item to browse to.
    - itemId: string
      The Id of the item.
    - itemName: string
      The name of the item.
    - Optional options: any
    Returns AxiosPromise<void>
- getAuthProviders:function
  - getAuthProviders(options?: any): AxiosPromise<NameIdPair[]>
  - - Defined in generated-client/api/session-api.ts:1030
    summary
    Get all auth providers.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<NameIdPair[]>
- getPasswordResetProviders:function
  - getPasswordResetProviders(options?: any): AxiosPromise<NameIdPair[]>
  - - Defined in generated-client/api/session-api.ts:1039
    summary
    Get all password reset providers.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<NameIdPair[]>
- getSessions:function
  - getSessions(controllableByUserId?: string, deviceId?: string, activeWithinSeconds?: number, options?: any): AxiosPromise<SessionInfo[]>
  - - Defined in generated-client/api/session-api.ts:1051
    summary
    Gets a list of sessions.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional controllableByUserId: string
    - Optional deviceId: string
    - Optional activeWithinSeconds: number
    - Optional options: any
    Returns AxiosPromise<SessionInfo[]>
- play:function
  - play(sessionId: string, playCommand: PlayCommand, itemIds: string[], startPositionTicks?: number, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, startIndex?: number, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/session-api.ts:1068
    summary
    Instructs a session to play an item.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session id.
    - playCommand: PlayCommand
      The type of play command to issue (PlayNow, PlayNext, PlayLast). Clients who have not yet implemented play next and play last may play now.
    - itemIds: string[]
      The ids of the items to play, comma delimited.
    - Optional startPositionTicks: number
    - Optional mediaSourceId: string
    - Optional audioStreamIndex: number
    - Optional subtitleStreamIndex: number
    - Optional startIndex: number
    - Optional options: any
    Returns AxiosPromise<void>
- postCapabilities:function
  - postCapabilities(id?: string, playableMediaTypes?: string[], supportedCommands?: GeneralCommandType[], supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/session-api.ts:1083
    summary
    Updates capabilities for a device.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional id: string
    - Optional playableMediaTypes: string[]
    - Optional supportedCommands: GeneralCommandType[]
    - Optional supportsMediaControl: boolean
    - Optional supportsSync: boolean
    - Optional supportsPersistentIdentifier: boolean
    - Optional options: any
    Returns AxiosPromise<void>
- postFullCapabilities:function
  - postFullCapabilities(clientCapabilitiesDto: ClientCapabilitiesDto, id?: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/session-api.ts:1094
    summary
    Updates capabilities for a device.
    
    throws
    {RequiredError}
    
    Parameters
    - clientCapabilitiesDto: ClientCapabilitiesDto
      The MediaBrowser.Model.Session.ClientCapabilities.
    - Optional id: string
    - Optional options: any
    Returns AxiosPromise<void>
- removeUserFromSession:function
  - removeUserFromSession(sessionId: string, userId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/session-api.ts:1105
    summary
    Removes an additional user from a session.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session id.
    - userId: string
      The user id.
    - Optional options: any
    Returns AxiosPromise<void>
- reportSessionEnded:function
  - reportSessionEnded(options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/session-api.ts:1114
    summary
    Reports that a session has ended.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<void>
- reportViewing:function
  - reportViewing(itemId: string, sessionId?: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/session-api.ts:1125
    summary
    Reports that a session is viewing an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional sessionId: string
    - Optional options: any
    Returns AxiosPromise<void>
- sendFullGeneralCommand:function
  - sendFullGeneralCommand(sessionId: string, generalCommand: GeneralCommand, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/session-api.ts:1136
    summary
    Issues a full general command to a client.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session id.
    - generalCommand: GeneralCommand
      The MediaBrowser.Model.Session.GeneralCommand.
    - Optional options: any
    Returns AxiosPromise<void>
- sendGeneralCommand:function
  - sendGeneralCommand(sessionId: string, command: GeneralCommandType, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/session-api.ts:1147
    summary
    Issues a general command to a client.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session id.
    - command: GeneralCommandType
      The command to send.
    - Optional options: any
    Returns AxiosPromise<void>
- sendMessageCommand:function
  - sendMessageCommand(sessionId: string, messageCommand: MessageCommand, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/session-api.ts:1158
    summary
    Issues a command to a client to display a message to the user.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session id.
    - messageCommand: MessageCommand
      The MediaBrowser.Model.Session.MessageCommand object containing Header, Message Text, and TimeoutMs.
    - Optional options: any
    Returns AxiosPromise<void>
- sendPlaystateCommand:function
  - sendPlaystateCommand(sessionId: string, command: PlaystateCommand, seekPositionTicks?: number, controllingUserId?: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/session-api.ts:1171
    summary
    Issues a playstate command to a client.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session id.
    - command: PlaystateCommand
      The MediaBrowser.Model.Session.PlaystateCommand.
    - Optional seekPositionTicks: number
    - Optional controllingUserId: string
    - Optional options: any
    Returns AxiosPromise<void>
- sendSystemCommand:function
  - sendSystemCommand(sessionId: string, command: GeneralCommandType, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/session-api.ts:1182
    summary
    Issues a system command to a client.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session id.
    - command: GeneralCommandType
      The command to send.
    - Optional options: any
    Returns AxiosPromise<void>

Const SessionApiFp

SessionApiFp(configuration?: Configuration): { addUserToSession: any; displayContent: any; getAuthProviders: any; getPasswordResetProviders: any; getSessions: any; play: any; postCapabilities: any; postFullCapabilities: any; removeUserFromSession: any; reportSessionEnded: any; reportViewing: any; sendFullGeneralCommand: any; sendGeneralCommand: any; sendMessageCommand: any; sendPlaystateCommand: any; sendSystemCommand: any }

- Defined in generated-client/api/session-api.ts:786
SessionApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { addUserToSession: any; displayContent: any; getAuthProviders: any; getPasswordResetProviders: any; getSessions: any; play: any; postCapabilities: any; postFullCapabilities: any; removeUserFromSession: any; reportSessionEnded: any; reportViewing: any; sendFullGeneralCommand: any; sendGeneralCommand: any; sendMessageCommand: any; sendPlaystateCommand: any; sendSystemCommand: any }
- addUserToSession:function
  - addUserToSession(sessionId: string, userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/session-api.ts:797
    summary
    Adds an additional user to a session.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session id.
    - userId: string
      The user id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- displayContent:function
  - displayContent(sessionId: string, itemType: string, itemId: string, itemName: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/session-api.ts:811
    summary
    Instructs a session to browse to an item or view.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session Id.
    - itemType: string
      The type of item to browse to.
    - itemId: string
      The Id of the item.
    - itemName: string
      The name of the item.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getAuthProviders:function
  - getAuthProviders(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
  - - Defined in generated-client/api/session-api.ts:821
    summary
    Get all auth providers.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
- getPasswordResetProviders:function
  - getPasswordResetProviders(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
  - - Defined in generated-client/api/session-api.ts:831
    summary
    Get all password reset providers.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NameIdPair[]>>
- getSessions:function
  - getSessions(controllableByUserId?: string, deviceId?: string, activeWithinSeconds?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SessionInfo[]>>
  - - Defined in generated-client/api/session-api.ts:844
    summary
    Gets a list of sessions.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional controllableByUserId: string
    - Optional deviceId: string
    - Optional activeWithinSeconds: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SessionInfo[]>>
- play:function
  - play(sessionId: string, playCommand: PlayCommand, itemIds: string[], startPositionTicks?: number, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, startIndex?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/session-api.ts:862
    summary
    Instructs a session to play an item.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session id.
    - playCommand: PlayCommand
      The type of play command to issue (PlayNow, PlayNext, PlayLast). Clients who have not yet implemented play next and play last may play now.
    - itemIds: string[]
      The ids of the items to play, comma delimited.
    - Optional startPositionTicks: number
    - Optional mediaSourceId: string
    - Optional audioStreamIndex: number
    - Optional subtitleStreamIndex: number
    - Optional startIndex: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- postCapabilities:function
  - postCapabilities(id?: string, playableMediaTypes?: string[], supportedCommands?: GeneralCommandType[], supportsMediaControl?: boolean, supportsSync?: boolean, supportsPersistentIdentifier?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/session-api.ts:878
    summary
    Updates capabilities for a device.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional id: string
    - Optional playableMediaTypes: string[]
    - Optional supportedCommands: GeneralCommandType[]
    - Optional supportsMediaControl: boolean
    - Optional supportsSync: boolean
    - Optional supportsPersistentIdentifier: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- postFullCapabilities:function
  - postFullCapabilities(clientCapabilitiesDto: ClientCapabilitiesDto, id?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/session-api.ts:890
    summary
    Updates capabilities for a device.
    
    throws
    {RequiredError}
    
    Parameters
    - clientCapabilitiesDto: ClientCapabilitiesDto
      The MediaBrowser.Model.Session.ClientCapabilities.
    - Optional id: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- removeUserFromSession:function
  - removeUserFromSession(sessionId: string, userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/session-api.ts:902
    summary
    Removes an additional user from a session.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session id.
    - userId: string
      The user id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- reportSessionEnded:function
  - reportSessionEnded(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/session-api.ts:912
    summary
    Reports that a session has ended.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- reportViewing:function
  - reportViewing(itemId: string, sessionId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/session-api.ts:924
    summary
    Reports that a session is viewing an item.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional sessionId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sendFullGeneralCommand:function
  - sendFullGeneralCommand(sessionId: string, generalCommand: GeneralCommand, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/session-api.ts:936
    summary
    Issues a full general command to a client.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session id.
    - generalCommand: GeneralCommand
      The MediaBrowser.Model.Session.GeneralCommand.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sendGeneralCommand:function
  - sendGeneralCommand(sessionId: string, command: GeneralCommandType, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/session-api.ts:948
    summary
    Issues a general command to a client.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session id.
    - command: GeneralCommandType
      The command to send.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sendMessageCommand:function
  - sendMessageCommand(sessionId: string, messageCommand: MessageCommand, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/session-api.ts:960
    summary
    Issues a command to a client to display a message to the user.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session id.
    - messageCommand: MessageCommand
      The MediaBrowser.Model.Session.MessageCommand object containing Header, Message Text, and TimeoutMs.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sendPlaystateCommand:function
  - sendPlaystateCommand(sessionId: string, command: PlaystateCommand, seekPositionTicks?: number, controllingUserId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/session-api.ts:974
    summary
    Issues a playstate command to a client.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session id.
    - command: PlaystateCommand
      The MediaBrowser.Model.Session.PlaystateCommand.
    - Optional seekPositionTicks: number
    - Optional controllingUserId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- sendSystemCommand:function
  - sendSystemCommand(sessionId: string, command: GeneralCommandType, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/session-api.ts:986
    summary
    Issues a system command to a client.
    
    throws
    {RequiredError}
    
    Parameters
    - sessionId: string
      The session id.
    - command: GeneralCommandType
      The command to send.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const StartupApiAxiosParamCreator

StartupApiAxiosParamCreator(configuration?: Configuration): { completeWizard: (options?: any) => Promise<RequestArgs>; getFirstUser: (options?: any) => Promise<RequestArgs>; getFirstUser2: (options?: any) => Promise<RequestArgs>; getStartupConfiguration: (options?: any) => Promise<RequestArgs>; setRemoteAccess: (startupRemoteAccessDto: StartupRemoteAccessDto, options?: any) => Promise<RequestArgs>; updateInitialConfiguration: (startupConfigurationDto: StartupConfigurationDto, options?: any) => Promise<RequestArgs>; updateStartupUser: (startupUserDto?: StartupUserDto, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/startup-api.ts:33
StartupApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { completeWizard: (options?: any) => Promise<RequestArgs>; getFirstUser: (options?: any) => Promise<RequestArgs>; getFirstUser2: (options?: any) => Promise<RequestArgs>; getStartupConfiguration: (options?: any) => Promise<RequestArgs>; setRemoteAccess: (startupRemoteAccessDto: StartupRemoteAccessDto, options?: any) => Promise<RequestArgs>; updateInitialConfiguration: (startupConfigurationDto: StartupConfigurationDto, options?: any) => Promise<RequestArgs>; updateStartupUser: (startupUserDto?: StartupUserDto, options?: any) => Promise<RequestArgs> }
- completeWizard: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Completes the startup wizard.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getFirstUser: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets the first user.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getFirstUser2: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets the first user.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getStartupConfiguration: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets the initial startup wizard configuration.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- setRemoteAccess: (startupRemoteAccessDto: StartupRemoteAccessDto, options?: any) => Promise<RequestArgs>
  - - (startupRemoteAccessDto: StartupRemoteAccessDto, options?: any): Promise<RequestArgs>
    - summary
      Sets remote access and UPnP.
      
      throws
      {RequiredError}
      
      Parameters
      - startupRemoteAccessDto: StartupRemoteAccessDto
        The startup remote access dto.
      - options: any = {}
      Returns Promise<RequestArgs>
- updateInitialConfiguration: (startupConfigurationDto: StartupConfigurationDto, options?: any) => Promise<RequestArgs>
  - - (startupConfigurationDto: StartupConfigurationDto, options?: any): Promise<RequestArgs>
    - summary
      Sets the initial startup wizard configuration.
      
      throws
      {RequiredError}
      
      Parameters
      - startupConfigurationDto: StartupConfigurationDto
        The updated startup configuration.
      - options: any = {}
      Returns Promise<RequestArgs>
- updateStartupUser: (startupUserDto?: StartupUserDto, options?: any) => Promise<RequestArgs>
  - - (startupUserDto?: StartupUserDto, options?: any): Promise<RequestArgs>
    - summary
      Sets the user name and password.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional startupUserDto: StartupUserDto
      - options: any = {}
      Returns Promise<RequestArgs>

Const StartupApiFactory

StartupApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { completeWizard: any; getFirstUser: any; getFirstUser2: any; getStartupConfiguration: any; setRemoteAccess: any; updateInitialConfiguration: any; updateStartupUser: any }

- Defined in generated-client/api/startup-api.ts:372
StartupApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { completeWizard: any; getFirstUser: any; getFirstUser2: any; getStartupConfiguration: any; setRemoteAccess: any; updateInitialConfiguration: any; updateStartupUser: any }
- completeWizard:function
  - completeWizard(options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/startup-api.ts:381
    summary
    Completes the startup wizard.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<void>
- getFirstUser:function
  - getFirstUser(options?: any): AxiosPromise<StartupUserDto>
  - - Defined in generated-client/api/startup-api.ts:390
    summary
    Gets the first user.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<StartupUserDto>
- getFirstUser2:function
  - getFirstUser2(options?: any): AxiosPromise<StartupUserDto>
  - - Defined in generated-client/api/startup-api.ts:399
    summary
    Gets the first user.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<StartupUserDto>
- getStartupConfiguration:function
  - getStartupConfiguration(options?: any): AxiosPromise<StartupConfigurationDto>
  - - Defined in generated-client/api/startup-api.ts:408
    summary
    Gets the initial startup wizard configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<StartupConfigurationDto>
- setRemoteAccess:function
  - setRemoteAccess(startupRemoteAccessDto: StartupRemoteAccessDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/startup-api.ts:418
    summary
    Sets remote access and UPnP.
    
    throws
    {RequiredError}
    
    Parameters
    - startupRemoteAccessDto: StartupRemoteAccessDto
      The startup remote access dto.
    - Optional options: any
    Returns AxiosPromise<void>
- updateInitialConfiguration:function
  - updateInitialConfiguration(startupConfigurationDto: StartupConfigurationDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/startup-api.ts:428
    summary
    Sets the initial startup wizard configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - startupConfigurationDto: StartupConfigurationDto
      The updated startup configuration.
    - Optional options: any
    Returns AxiosPromise<void>
- updateStartupUser:function
  - updateStartupUser(startupUserDto?: StartupUserDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/startup-api.ts:438
    summary
    Sets the user name and password.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional startupUserDto: StartupUserDto
    - Optional options: any
    Returns AxiosPromise<void>

Const StartupApiFp

StartupApiFp(configuration?: Configuration): { completeWizard: any; getFirstUser: any; getFirstUser2: any; getStartupConfiguration: any; setRemoteAccess: any; updateInitialConfiguration: any; updateStartupUser: any }

- Defined in generated-client/api/startup-api.ts:289
StartupApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { completeWizard: any; getFirstUser: any; getFirstUser2: any; getStartupConfiguration: any; setRemoteAccess: any; updateInitialConfiguration: any; updateStartupUser: any }
- completeWizard:function
  - completeWizard(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/startup-api.ts:298
    summary
    Completes the startup wizard.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getFirstUser:function
  - getFirstUser(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupUserDto>>
  - - Defined in generated-client/api/startup-api.ts:308
    summary
    Gets the first user.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupUserDto>>
- getFirstUser2:function
  - getFirstUser2(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupUserDto>>
  - - Defined in generated-client/api/startup-api.ts:318
    summary
    Gets the first user.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupUserDto>>
- getStartupConfiguration:function
  - getStartupConfiguration(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupConfigurationDto>>
  - - Defined in generated-client/api/startup-api.ts:328
    summary
    Gets the initial startup wizard configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StartupConfigurationDto>>
- setRemoteAccess:function
  - setRemoteAccess(startupRemoteAccessDto: StartupRemoteAccessDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/startup-api.ts:339
    summary
    Sets remote access and UPnP.
    
    throws
    {RequiredError}
    
    Parameters
    - startupRemoteAccessDto: StartupRemoteAccessDto
      The startup remote access dto.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- updateInitialConfiguration:function
  - updateInitialConfiguration(startupConfigurationDto: StartupConfigurationDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/startup-api.ts:350
    summary
    Sets the initial startup wizard configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - startupConfigurationDto: StartupConfigurationDto
      The updated startup configuration.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- updateStartupUser:function
  - updateStartupUser(startupUserDto?: StartupUserDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/startup-api.ts:361
    summary
    Sets the user name and password.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional startupUserDto: StartupUserDto
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const StudiosApiAxiosParamCreator

StudiosApiAxiosParamCreator(configuration?: Configuration): { getStudio: (name: string, userId?: string, options?: any) => Promise<RequestArgs>; getStudios: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/studios-api.ts:35
StudiosApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getStudio: (name: string, userId?: string, options?: any) => Promise<RequestArgs>; getStudios: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }
- getStudio: (name: string, userId?: string, options?: any) => Promise<RequestArgs>
  - - (name: string, userId?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a studio by name.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        Studio name.
      - Optional userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getStudios: (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
  - - (startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets all studios from a given item, folder, or the entire library.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional startIndex: number
      - Optional limit: number
      - Optional searchTerm: string
      - Optional parentId: string
      - Optional fields: ItemFields[]
      - Optional excludeItemTypes: string[]
      - Optional includeItemTypes: string[]
      - Optional isFavorite: boolean
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional userId: string
      - Optional nameStartsWithOrGreater: string
      - Optional nameStartsWith: string
      - Optional nameLessThan: string
      - Optional enableImages: boolean
      - Optional enableTotalRecordCount: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const StudiosApiFactory

StudiosApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getStudio: any; getStudios: any }

- Defined in generated-client/api/studios-api.ts:253
StudiosApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getStudio: any; getStudios: any }
- getStudio:function
  - getStudio(name: string, userId?: string, options?: any): AxiosPromise<BaseItemDto>
  - - Defined in generated-client/api/studios-api.ts:264
    summary
    Gets a studio by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Studio name.
    - Optional userId: string
    - Optional options: any
    Returns AxiosPromise<BaseItemDto>
- getStudios:function
  - getStudios(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/studios-api.ts:290
    summary
    Gets all studios from a given item, folder, or the entire library.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional startIndex: number
    - Optional limit: number
    - Optional searchTerm: string
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional isFavorite: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional userId: string
    - Optional nameStartsWithOrGreater: string
    - Optional nameStartsWith: string
    - Optional nameLessThan: string
    - Optional enableImages: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>

Const StudiosApiFp

StudiosApiFp(configuration?: Configuration): { getStudio: any; getStudios: any }

- Defined in generated-client/api/studios-api.ts:204
StudiosApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getStudio: any; getStudios: any }
- getStudio:function
  - getStudio(name: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
  - - Defined in generated-client/api/studios-api.ts:215
    summary
    Gets a studio by name.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      Studio name.
    - Optional userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
- getStudios:function
  - getStudios(startIndex?: number, limit?: number, searchTerm?: string, parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], isFavorite?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, enableImages?: boolean, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/studios-api.ts:242
    summary
    Gets all studios from a given item, folder, or the entire library.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional startIndex: number
    - Optional limit: number
    - Optional searchTerm: string
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional isFavorite: boolean
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional userId: string
    - Optional nameStartsWithOrGreater: string
    - Optional nameStartsWith: string
    - Optional nameLessThan: string
    - Optional enableImages: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>

Const SubtitleApiAxiosParamCreator

SubtitleApiAxiosParamCreator(configuration?: Configuration): { deleteSubtitle: (itemId: string, index: number, options?: any) => Promise<RequestArgs>; downloadRemoteSubtitles: (itemId: string, subtitleId: string, options?: any) => Promise<RequestArgs>; getFallbackFont: (name: string, options?: any) => Promise<RequestArgs>; getFallbackFontList: (options?: any) => Promise<RequestArgs>; getRemoteSubtitles: (id: string, options?: any) => Promise<RequestArgs>; getSubtitle: (routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, startPositionTicks?: number, options?: any) => Promise<RequestArgs>; getSubtitlePlaylist: (itemId: string, index: number, mediaSourceId: string, segmentLength: number, options?: any) => Promise<RequestArgs>; getSubtitleWithTicks: (routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeStartPositionTicks: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, startPositionTicks?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, options?: any) => Promise<RequestArgs>; searchRemoteSubtitles: (itemId: string, language: string, isPerfectMatch?: boolean, options?: any) => Promise<RequestArgs>; uploadSubtitle: (itemId: string, uploadSubtitleDto: UploadSubtitleDto, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/subtitle-api.ts:35
SubtitleApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { deleteSubtitle: (itemId: string, index: number, options?: any) => Promise<RequestArgs>; downloadRemoteSubtitles: (itemId: string, subtitleId: string, options?: any) => Promise<RequestArgs>; getFallbackFont: (name: string, options?: any) => Promise<RequestArgs>; getFallbackFontList: (options?: any) => Promise<RequestArgs>; getRemoteSubtitles: (id: string, options?: any) => Promise<RequestArgs>; getSubtitle: (routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, startPositionTicks?: number, options?: any) => Promise<RequestArgs>; getSubtitlePlaylist: (itemId: string, index: number, mediaSourceId: string, segmentLength: number, options?: any) => Promise<RequestArgs>; getSubtitleWithTicks: (routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeStartPositionTicks: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, startPositionTicks?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, options?: any) => Promise<RequestArgs>; searchRemoteSubtitles: (itemId: string, language: string, isPerfectMatch?: boolean, options?: any) => Promise<RequestArgs>; uploadSubtitle: (itemId: string, uploadSubtitleDto: UploadSubtitleDto, options?: any) => Promise<RequestArgs> }
- deleteSubtitle: (itemId: string, index: number, options?: any) => Promise<RequestArgs>
  - - (itemId: string, index: number, options?: any): Promise<RequestArgs>
    - summary
      Deletes an external subtitle file.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - index: number
        The index of the subtitle file.
      - options: any = {}
      Returns Promise<RequestArgs>
- downloadRemoteSubtitles: (itemId: string, subtitleId: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, subtitleId: string, options?: any): Promise<RequestArgs>
    - summary
      Downloads a remote subtitle.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - subtitleId: string
        The subtitle id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getFallbackFont: (name: string, options?: any) => Promise<RequestArgs>
  - - (name: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a fallback font file.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        The name of the fallback font file to get.
      - options: any = {}
      Returns Promise<RequestArgs>
- getFallbackFontList: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets a list of available fallback font files.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getRemoteSubtitles: (id: string, options?: any) => Promise<RequestArgs>
  - - (id: string, options?: any): Promise<RequestArgs>
    - summary
      Gets the remote subtitles.
      
      throws
      {RequiredError}
      
      Parameters
      - id: string
        The item id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getSubtitle: (routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, startPositionTicks?: number, options?: any) => Promise<RequestArgs>
  - - (routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, startPositionTicks?: number, options?: any): Promise<RequestArgs>
    - summary
      Gets subtitles in a specified format.
      
      throws
      {RequiredError}
      
      Parameters
      - routeItemId: string
        The (route) item id.
      - routeMediaSourceId: string
        The (route) media source id.
      - routeIndex: number
        The (route) subtitle stream index.
      - routeFormat: string
        The (route) format of the returned subtitle.
      - Optional itemId: string
      - Optional mediaSourceId: string
      - Optional index: number
      - Optional format: string
      - Optional endPositionTicks: number
      - Optional copyTimestamps: boolean
      - Optional addVttTimeMap: boolean
      - Optional startPositionTicks: number
      - options: any = {}
      Returns Promise<RequestArgs>
- getSubtitlePlaylist: (itemId: string, index: number, mediaSourceId: string, segmentLength: number, options?: any) => Promise<RequestArgs>
  - - (itemId: string, index: number, mediaSourceId: string, segmentLength: number, options?: any): Promise<RequestArgs>
    - summary
      Gets an HLS subtitle playlist.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - index: number
        The subtitle stream index.
      - mediaSourceId: string
        The media source id.
      - segmentLength: number
        The subtitle segment length.
      - options: any = {}
      Returns Promise<RequestArgs>
- getSubtitleWithTicks: (routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeStartPositionTicks: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, startPositionTicks?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, options?: any) => Promise<RequestArgs>
  - - (routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeStartPositionTicks: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, startPositionTicks?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets subtitles in a specified format.
      
      throws
      {RequiredError}
      
      Parameters
      - routeItemId: string
        The (route) item id.
      - routeMediaSourceId: string
        The (route) media source id.
      - routeIndex: number
        The (route) subtitle stream index.
      - routeStartPositionTicks: number
        The (route) start position of the subtitle in ticks.
      - routeFormat: string
        The (route) format of the returned subtitle.
      - Optional itemId: string
      - Optional mediaSourceId: string
      - Optional index: number
      - Optional startPositionTicks: number
      - Optional format: string
      - Optional endPositionTicks: number
      - Optional copyTimestamps: boolean
      - Optional addVttTimeMap: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- searchRemoteSubtitles: (itemId: string, language: string, isPerfectMatch?: boolean, options?: any) => Promise<RequestArgs>
  - - (itemId: string, language: string, isPerfectMatch?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Search remote subtitles.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - language: string
        The language of the subtitles.
      - Optional isPerfectMatch: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- uploadSubtitle: (itemId: string, uploadSubtitleDto: UploadSubtitleDto, options?: any) => Promise<RequestArgs>
  - - (itemId: string, uploadSubtitleDto: UploadSubtitleDto, options?: any): Promise<RequestArgs>
    - summary
      Upload an external subtitle file.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item the subtitle belongs to.
      - uploadSubtitleDto: UploadSubtitleDto
        The request body.
      - options: any = {}
      Returns Promise<RequestArgs>

Const SubtitleApiFactory

SubtitleApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { deleteSubtitle: any; downloadRemoteSubtitles: any; getFallbackFont: any; getFallbackFontList: any; getRemoteSubtitles: any; getSubtitle: any; getSubtitlePlaylist: any; getSubtitleWithTicks: any; searchRemoteSubtitles: any; uploadSubtitle: any }

- Defined in generated-client/api/subtitle-api.ts:700
SubtitleApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { deleteSubtitle: any; downloadRemoteSubtitles: any; getFallbackFont: any; getFallbackFontList: any; getRemoteSubtitles: any; getSubtitle: any; getSubtitlePlaylist: any; getSubtitleWithTicks: any; searchRemoteSubtitles: any; uploadSubtitle: any }
- deleteSubtitle:function
  - deleteSubtitle(itemId: string, index: number, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/subtitle-api.ts:711
    summary
    Deletes an external subtitle file.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - index: number
      The index of the subtitle file.
    - Optional options: any
    Returns AxiosPromise<void>
- downloadRemoteSubtitles:function
  - downloadRemoteSubtitles(itemId: string, subtitleId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/subtitle-api.ts:722
    summary
    Downloads a remote subtitle.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - subtitleId: string
      The subtitle id.
    - Optional options: any
    Returns AxiosPromise<void>
- getFallbackFont:function
  - getFallbackFont(name: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/subtitle-api.ts:732
    summary
    Gets a fallback font file.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      The name of the fallback font file to get.
    - Optional options: any
    Returns AxiosPromise<any>
- getFallbackFontList:function
  - getFallbackFontList(options?: any): AxiosPromise<FontFile[]>
  - - Defined in generated-client/api/subtitle-api.ts:741
    summary
    Gets a list of available fallback font files.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<FontFile[]>
- getRemoteSubtitles:function
  - getRemoteSubtitles(id: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/subtitle-api.ts:751
    summary
    Gets the remote subtitles.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional options: any
    Returns AxiosPromise<any>
- getSubtitle:function
  - getSubtitle(routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, startPositionTicks?: number, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/subtitle-api.ts:772
    summary
    Gets subtitles in a specified format.
    
    throws
    {RequiredError}
    
    Parameters
    - routeItemId: string
      The (route) item id.
    - routeMediaSourceId: string
      The (route) media source id.
    - routeIndex: number
      The (route) subtitle stream index.
    - routeFormat: string
      The (route) format of the returned subtitle.
    - Optional itemId: string
    - Optional mediaSourceId: string
    - Optional index: number
    - Optional format: string
    - Optional endPositionTicks: number
    - Optional copyTimestamps: boolean
    - Optional addVttTimeMap: boolean
    - Optional startPositionTicks: number
    - Optional options: any
    Returns AxiosPromise<any>
- getSubtitlePlaylist:function
  - getSubtitlePlaylist(itemId: string, index: number, mediaSourceId: string, segmentLength: number, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/subtitle-api.ts:785
    summary
    Gets an HLS subtitle playlist.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - index: number
      The subtitle stream index.
    - mediaSourceId: string
      The media source id.
    - segmentLength: number
      The subtitle segment length.
    - Optional options: any
    Returns AxiosPromise<any>
- getSubtitleWithTicks:function
  - getSubtitleWithTicks(routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeStartPositionTicks: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, startPositionTicks?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/subtitle-api.ts:807
    summary
    Gets subtitles in a specified format.
    
    throws
    {RequiredError}
    
    Parameters
    - routeItemId: string
      The (route) item id.
    - routeMediaSourceId: string
      The (route) media source id.
    - routeIndex: number
      The (route) subtitle stream index.
    - routeStartPositionTicks: number
      The (route) start position of the subtitle in ticks.
    - routeFormat: string
      The (route) format of the returned subtitle.
    - Optional itemId: string
    - Optional mediaSourceId: string
    - Optional index: number
    - Optional startPositionTicks: number
    - Optional format: string
    - Optional endPositionTicks: number
    - Optional copyTimestamps: boolean
    - Optional addVttTimeMap: boolean
    - Optional options: any
    Returns AxiosPromise<any>
- searchRemoteSubtitles:function
  - searchRemoteSubtitles(itemId: string, language: string, isPerfectMatch?: boolean, options?: any): AxiosPromise<RemoteSubtitleInfo[]>
  - - Defined in generated-client/api/subtitle-api.ts:819
    summary
    Search remote subtitles.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - language: string
      The language of the subtitles.
    - Optional isPerfectMatch: boolean
    - Optional options: any
    Returns AxiosPromise<RemoteSubtitleInfo[]>
- uploadSubtitle:function
  - uploadSubtitle(itemId: string, uploadSubtitleDto: UploadSubtitleDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/subtitle-api.ts:830
    summary
    Upload an external subtitle file.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item the subtitle belongs to.
    - uploadSubtitleDto: UploadSubtitleDto
      The request body.
    - Optional options: any
    Returns AxiosPromise<void>

Const SubtitleApiFp

SubtitleApiFp(configuration?: Configuration): { deleteSubtitle: any; downloadRemoteSubtitles: any; getFallbackFont: any; getFallbackFontList: any; getRemoteSubtitles: any; getSubtitle: any; getSubtitlePlaylist: any; getSubtitleWithTicks: any; searchRemoteSubtitles: any; uploadSubtitle: any }

- Defined in generated-client/api/subtitle-api.ts:550
SubtitleApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { deleteSubtitle: any; downloadRemoteSubtitles: any; getFallbackFont: any; getFallbackFontList: any; getRemoteSubtitles: any; getSubtitle: any; getSubtitlePlaylist: any; getSubtitleWithTicks: any; searchRemoteSubtitles: any; uploadSubtitle: any }
- deleteSubtitle:function
  - deleteSubtitle(itemId: string, index: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/subtitle-api.ts:561
    summary
    Deletes an external subtitle file.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - index: number
      The index of the subtitle file.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- downloadRemoteSubtitles:function
  - downloadRemoteSubtitles(itemId: string, subtitleId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/subtitle-api.ts:573
    summary
    Downloads a remote subtitle.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - subtitleId: string
      The subtitle id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getFallbackFont:function
  - getFallbackFont(name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/subtitle-api.ts:584
    summary
    Gets a fallback font file.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      The name of the fallback font file to get.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getFallbackFontList:function
  - getFallbackFontList(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FontFile[]>>
  - - Defined in generated-client/api/subtitle-api.ts:594
    summary
    Gets a list of available fallback font files.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FontFile[]>>
- getRemoteSubtitles:function
  - getRemoteSubtitles(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/subtitle-api.ts:605
    summary
    Gets the remote subtitles.
    
    throws
    {RequiredError}
    
    Parameters
    - id: string
      The item id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getSubtitle:function
  - getSubtitle(routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, startPositionTicks?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/subtitle-api.ts:627
    summary
    Gets subtitles in a specified format.
    
    throws
    {RequiredError}
    
    Parameters
    - routeItemId: string
      The (route) item id.
    - routeMediaSourceId: string
      The (route) media source id.
    - routeIndex: number
      The (route) subtitle stream index.
    - routeFormat: string
      The (route) format of the returned subtitle.
    - Optional itemId: string
    - Optional mediaSourceId: string
    - Optional index: number
    - Optional format: string
    - Optional endPositionTicks: number
    - Optional copyTimestamps: boolean
    - Optional addVttTimeMap: boolean
    - Optional startPositionTicks: number
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getSubtitlePlaylist:function
  - getSubtitlePlaylist(itemId: string, index: number, mediaSourceId: string, segmentLength: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/subtitle-api.ts:641
    summary
    Gets an HLS subtitle playlist.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - index: number
      The subtitle stream index.
    - mediaSourceId: string
      The media source id.
    - segmentLength: number
      The subtitle segment length.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getSubtitleWithTicks:function
  - getSubtitleWithTicks(routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeStartPositionTicks: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, startPositionTicks?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/subtitle-api.ts:664
    summary
    Gets subtitles in a specified format.
    
    throws
    {RequiredError}
    
    Parameters
    - routeItemId: string
      The (route) item id.
    - routeMediaSourceId: string
      The (route) media source id.
    - routeIndex: number
      The (route) subtitle stream index.
    - routeStartPositionTicks: number
      The (route) start position of the subtitle in ticks.
    - routeFormat: string
      The (route) format of the returned subtitle.
    - Optional itemId: string
    - Optional mediaSourceId: string
    - Optional index: number
    - Optional startPositionTicks: number
    - Optional format: string
    - Optional endPositionTicks: number
    - Optional copyTimestamps: boolean
    - Optional addVttTimeMap: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- searchRemoteSubtitles:function
  - searchRemoteSubtitles(itemId: string, language: string, isPerfectMatch?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSubtitleInfo[]>>
  - - Defined in generated-client/api/subtitle-api.ts:677
    summary
    Search remote subtitles.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - language: string
      The language of the subtitles.
    - Optional isPerfectMatch: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoteSubtitleInfo[]>>
- uploadSubtitle:function
  - uploadSubtitle(itemId: string, uploadSubtitleDto: UploadSubtitleDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/subtitle-api.ts:689
    summary
    Upload an external subtitle file.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item the subtitle belongs to.
    - uploadSubtitleDto: UploadSubtitleDto
      The request body.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const SuggestionsApiAxiosParamCreator

SuggestionsApiAxiosParamCreator(configuration?: Configuration): { getSuggestions: (userId: string, mediaType?: string[], type?: string[], startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/suggestions-api.ts:29
SuggestionsApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getSuggestions: (userId: string, mediaType?: string[], type?: string[], startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs> }
- getSuggestions: (userId: string, mediaType?: string[], type?: string[], startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: any) => Promise<RequestArgs>
  - - (userId: string, mediaType?: string[], type?: string[], startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets suggestions.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        The user id.
      - Optional mediaType: string[]
      - Optional type: string[]
      - Optional startIndex: number
      - Optional limit: number
      - Optional enableTotalRecordCount: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const SuggestionsApiFactory

SuggestionsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getSuggestions: any }

- Defined in generated-client/api/suggestions-api.ts:126
SuggestionsApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getSuggestions: any }
- getSuggestions:function
  - getSuggestions(userId: string, mediaType?: string[], type?: string[], startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/suggestions-api.ts:141
    summary
    Gets suggestions.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - Optional mediaType: string[]
    - Optional type: string[]
    - Optional startIndex: number
    - Optional limit: number
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>

Const SuggestionsApiFp

SuggestionsApiFp(configuration?: Configuration): { getSuggestions: any }

- Defined in generated-client/api/suggestions-api.ts:100
SuggestionsApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getSuggestions: any }
- getSuggestions:function
  - getSuggestions(userId: string, mediaType?: string[], type?: string[], startIndex?: number, limit?: number, enableTotalRecordCount?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/suggestions-api.ts:115
    summary
    Gets suggestions.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - Optional mediaType: string[]
    - Optional type: string[]
    - Optional startIndex: number
    - Optional limit: number
    - Optional enableTotalRecordCount: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>

Const SyncPlayApiAxiosParamCreator

SyncPlayApiAxiosParamCreator(configuration?: Configuration): { syncPlayBuffering: (bufferRequestDto: BufferRequestDto, options?: any) => Promise<RequestArgs>; syncPlayCreateGroup: (newGroupRequestDto: NewGroupRequestDto, options?: any) => Promise<RequestArgs>; syncPlayGetGroups: (options?: any) => Promise<RequestArgs>; syncPlayJoinGroup: (joinGroupRequestDto: JoinGroupRequestDto, options?: any) => Promise<RequestArgs>; syncPlayLeaveGroup: (options?: any) => Promise<RequestArgs>; syncPlayMovePlaylistItem: (movePlaylistItemRequestDto: MovePlaylistItemRequestDto, options?: any) => Promise<RequestArgs>; syncPlayNextItem: (nextItemRequestDto: NextItemRequestDto, options?: any) => Promise<RequestArgs>; syncPlayPause: (options?: any) => Promise<RequestArgs>; syncPlayPing: (pingRequestDto: PingRequestDto, options?: any) => Promise<RequestArgs>; syncPlayPreviousItem: (previousItemRequestDto: PreviousItemRequestDto, options?: any) => Promise<RequestArgs>; syncPlayQueue: (queueRequestDto: QueueRequestDto, options?: any) => Promise<RequestArgs>; syncPlayReady: (readyRequestDto: ReadyRequestDto, options?: any) => Promise<RequestArgs>; syncPlayRemoveFromPlaylist: (removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySeek: (seekRequestDto: SeekRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetIgnoreWait: (ignoreWaitRequestDto: IgnoreWaitRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetNewQueue: (playRequestDto: PlayRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetPlaylistItem: (setPlaylistItemRequestDto: SetPlaylistItemRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetRepeatMode: (setRepeatModeRequestDto: SetRepeatModeRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetShuffleMode: (setShuffleModeRequestDto: SetShuffleModeRequestDto, options?: any) => Promise<RequestArgs>; syncPlayStop: (options?: any) => Promise<RequestArgs>; syncPlayUnpause: (options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/sync-play-api.ts:61
SyncPlayApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { syncPlayBuffering: (bufferRequestDto: BufferRequestDto, options?: any) => Promise<RequestArgs>; syncPlayCreateGroup: (newGroupRequestDto: NewGroupRequestDto, options?: any) => Promise<RequestArgs>; syncPlayGetGroups: (options?: any) => Promise<RequestArgs>; syncPlayJoinGroup: (joinGroupRequestDto: JoinGroupRequestDto, options?: any) => Promise<RequestArgs>; syncPlayLeaveGroup: (options?: any) => Promise<RequestArgs>; syncPlayMovePlaylistItem: (movePlaylistItemRequestDto: MovePlaylistItemRequestDto, options?: any) => Promise<RequestArgs>; syncPlayNextItem: (nextItemRequestDto: NextItemRequestDto, options?: any) => Promise<RequestArgs>; syncPlayPause: (options?: any) => Promise<RequestArgs>; syncPlayPing: (pingRequestDto: PingRequestDto, options?: any) => Promise<RequestArgs>; syncPlayPreviousItem: (previousItemRequestDto: PreviousItemRequestDto, options?: any) => Promise<RequestArgs>; syncPlayQueue: (queueRequestDto: QueueRequestDto, options?: any) => Promise<RequestArgs>; syncPlayReady: (readyRequestDto: ReadyRequestDto, options?: any) => Promise<RequestArgs>; syncPlayRemoveFromPlaylist: (removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySeek: (seekRequestDto: SeekRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetIgnoreWait: (ignoreWaitRequestDto: IgnoreWaitRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetNewQueue: (playRequestDto: PlayRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetPlaylistItem: (setPlaylistItemRequestDto: SetPlaylistItemRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetRepeatMode: (setRepeatModeRequestDto: SetRepeatModeRequestDto, options?: any) => Promise<RequestArgs>; syncPlaySetShuffleMode: (setShuffleModeRequestDto: SetShuffleModeRequestDto, options?: any) => Promise<RequestArgs>; syncPlayStop: (options?: any) => Promise<RequestArgs>; syncPlayUnpause: (options?: any) => Promise<RequestArgs> }
- syncPlayBuffering: (bufferRequestDto: BufferRequestDto, options?: any) => Promise<RequestArgs>
  - - (bufferRequestDto: BufferRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Notify SyncPlay group that member is buffering.
      
      throws
      {RequiredError}
      
      Parameters
      - bufferRequestDto: BufferRequestDto
        The player status.
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlayCreateGroup: (newGroupRequestDto: NewGroupRequestDto, options?: any) => Promise<RequestArgs>
  - - (newGroupRequestDto: NewGroupRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Create a new SyncPlay group.
      
      throws
      {RequiredError}
      
      Parameters
      - newGroupRequestDto: NewGroupRequestDto
        The settings of the new group.
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlayGetGroups: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets all SyncPlay groups.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlayJoinGroup: (joinGroupRequestDto: JoinGroupRequestDto, options?: any) => Promise<RequestArgs>
  - - (joinGroupRequestDto: JoinGroupRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Join an existing SyncPlay group.
      
      throws
      {RequiredError}
      
      Parameters
      - joinGroupRequestDto: JoinGroupRequestDto
        The group to join.
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlayLeaveGroup: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Leave the joined SyncPlay group.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlayMovePlaylistItem: (movePlaylistItemRequestDto: MovePlaylistItemRequestDto, options?: any) => Promise<RequestArgs>
  - - (movePlaylistItemRequestDto: MovePlaylistItemRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Request to move an item in the playlist in SyncPlay group.
      
      throws
      {RequiredError}
      
      Parameters
      - movePlaylistItemRequestDto: MovePlaylistItemRequestDto
        The new position for the item.
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlayNextItem: (nextItemRequestDto: NextItemRequestDto, options?: any) => Promise<RequestArgs>
  - - (nextItemRequestDto: NextItemRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Request next item in SyncPlay group.
      
      throws
      {RequiredError}
      
      Parameters
      - nextItemRequestDto: NextItemRequestDto
        The current item information.
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlayPause: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Request pause in SyncPlay group.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlayPing: (pingRequestDto: PingRequestDto, options?: any) => Promise<RequestArgs>
  - - (pingRequestDto: PingRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Update session ping.
      
      throws
      {RequiredError}
      
      Parameters
      - pingRequestDto: PingRequestDto
        The new ping.
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlayPreviousItem: (previousItemRequestDto: PreviousItemRequestDto, options?: any) => Promise<RequestArgs>
  - - (previousItemRequestDto: PreviousItemRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Request previous item in SyncPlay group.
      
      throws
      {RequiredError}
      
      Parameters
      - previousItemRequestDto: PreviousItemRequestDto
        The current item information.
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlayQueue: (queueRequestDto: QueueRequestDto, options?: any) => Promise<RequestArgs>
  - - (queueRequestDto: QueueRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Request to queue items to the playlist of a SyncPlay group.
      
      throws
      {RequiredError}
      
      Parameters
      - queueRequestDto: QueueRequestDto
        The items to add.
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlayReady: (readyRequestDto: ReadyRequestDto, options?: any) => Promise<RequestArgs>
  - - (readyRequestDto: ReadyRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Notify SyncPlay group that member is ready for playback.
      
      throws
      {RequiredError}
      
      Parameters
      - readyRequestDto: ReadyRequestDto
        The player status.
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlayRemoveFromPlaylist: (removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto, options?: any) => Promise<RequestArgs>
  - - (removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Request to remove items from the playlist in SyncPlay group.
      
      throws
      {RequiredError}
      
      Parameters
      - removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto
        The items to remove.
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlaySeek: (seekRequestDto: SeekRequestDto, options?: any) => Promise<RequestArgs>
  - - (seekRequestDto: SeekRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Request seek in SyncPlay group.
      
      throws
      {RequiredError}
      
      Parameters
      - seekRequestDto: SeekRequestDto
        The new playback position.
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlaySetIgnoreWait: (ignoreWaitRequestDto: IgnoreWaitRequestDto, options?: any) => Promise<RequestArgs>
  - - (ignoreWaitRequestDto: IgnoreWaitRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Request SyncPlay group to ignore member during group-wait.
      
      throws
      {RequiredError}
      
      Parameters
      - ignoreWaitRequestDto: IgnoreWaitRequestDto
        The settings to set.
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlaySetNewQueue: (playRequestDto: PlayRequestDto, options?: any) => Promise<RequestArgs>
  - - (playRequestDto: PlayRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Request to set new playlist in SyncPlay group.
      
      throws
      {RequiredError}
      
      Parameters
      - playRequestDto: PlayRequestDto
        The new playlist to play in the group.
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlaySetPlaylistItem: (setPlaylistItemRequestDto: SetPlaylistItemRequestDto, options?: any) => Promise<RequestArgs>
  - - (setPlaylistItemRequestDto: SetPlaylistItemRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Request to change playlist item in SyncPlay group.
      
      throws
      {RequiredError}
      
      Parameters
      - setPlaylistItemRequestDto: SetPlaylistItemRequestDto
        The new item to play.
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlaySetRepeatMode: (setRepeatModeRequestDto: SetRepeatModeRequestDto, options?: any) => Promise<RequestArgs>
  - - (setRepeatModeRequestDto: SetRepeatModeRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Request to set repeat mode in SyncPlay group.
      
      throws
      {RequiredError}
      
      Parameters
      - setRepeatModeRequestDto: SetRepeatModeRequestDto
        The new repeat mode.
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlaySetShuffleMode: (setShuffleModeRequestDto: SetShuffleModeRequestDto, options?: any) => Promise<RequestArgs>
  - - (setShuffleModeRequestDto: SetShuffleModeRequestDto, options?: any): Promise<RequestArgs>
    - summary
      Request to set shuffle mode in SyncPlay group.
      
      throws
      {RequiredError}
      
      Parameters
      - setShuffleModeRequestDto: SetShuffleModeRequestDto
        The new shuffle mode.
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlayStop: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Request stop in SyncPlay group.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- syncPlayUnpause: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Request unpause in SyncPlay group.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>

Const SyncPlayApiFactory

SyncPlayApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { syncPlayBuffering: any; syncPlayCreateGroup: any; syncPlayGetGroups: any; syncPlayJoinGroup: any; syncPlayLeaveGroup: any; syncPlayMovePlaylistItem: any; syncPlayNextItem: any; syncPlayPause: any; syncPlayPing: any; syncPlayPreviousItem: any; syncPlayQueue: any; syncPlayReady: any; syncPlayRemoveFromPlaylist: any; syncPlaySeek: any; syncPlaySetIgnoreWait: any; syncPlaySetNewQueue: any; syncPlaySetPlaylistItem: any; syncPlaySetRepeatMode: any; syncPlaySetShuffleMode: any; syncPlayStop: any; syncPlayUnpause: any }

- Defined in generated-client/api/sync-play-api.ts:1095
SyncPlayApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { syncPlayBuffering: any; syncPlayCreateGroup: any; syncPlayGetGroups: any; syncPlayJoinGroup: any; syncPlayLeaveGroup: any; syncPlayMovePlaylistItem: any; syncPlayNextItem: any; syncPlayPause: any; syncPlayPing: any; syncPlayPreviousItem: any; syncPlayQueue: any; syncPlayReady: any; syncPlayRemoveFromPlaylist: any; syncPlaySeek: any; syncPlaySetIgnoreWait: any; syncPlaySetNewQueue: any; syncPlaySetPlaylistItem: any; syncPlaySetRepeatMode: any; syncPlaySetShuffleMode: any; syncPlayStop: any; syncPlayUnpause: any }
- syncPlayBuffering:function
  - syncPlayBuffering(bufferRequestDto: BufferRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1105
    summary
    Notify SyncPlay group that member is buffering.
    
    throws
    {RequiredError}
    
    Parameters
    - bufferRequestDto: BufferRequestDto
      The player status.
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlayCreateGroup:function
  - syncPlayCreateGroup(newGroupRequestDto: NewGroupRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1115
    summary
    Create a new SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - newGroupRequestDto: NewGroupRequestDto
      The settings of the new group.
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlayGetGroups:function
  - syncPlayGetGroups(options?: any): AxiosPromise<GroupInfoDto[]>
  - - Defined in generated-client/api/sync-play-api.ts:1124
    summary
    Gets all SyncPlay groups.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<GroupInfoDto[]>
- syncPlayJoinGroup:function
  - syncPlayJoinGroup(joinGroupRequestDto: JoinGroupRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1134
    summary
    Join an existing SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - joinGroupRequestDto: JoinGroupRequestDto
      The group to join.
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlayLeaveGroup:function
  - syncPlayLeaveGroup(options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1143
    summary
    Leave the joined SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlayMovePlaylistItem:function
  - syncPlayMovePlaylistItem(movePlaylistItemRequestDto: MovePlaylistItemRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1153
    summary
    Request to move an item in the playlist in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - movePlaylistItemRequestDto: MovePlaylistItemRequestDto
      The new position for the item.
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlayNextItem:function
  - syncPlayNextItem(nextItemRequestDto: NextItemRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1163
    summary
    Request next item in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - nextItemRequestDto: NextItemRequestDto
      The current item information.
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlayPause:function
  - syncPlayPause(options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1172
    summary
    Request pause in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlayPing:function
  - syncPlayPing(pingRequestDto: PingRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1182
    summary
    Update session ping.
    
    throws
    {RequiredError}
    
    Parameters
    - pingRequestDto: PingRequestDto
      The new ping.
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlayPreviousItem:function
  - syncPlayPreviousItem(previousItemRequestDto: PreviousItemRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1192
    summary
    Request previous item in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - previousItemRequestDto: PreviousItemRequestDto
      The current item information.
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlayQueue:function
  - syncPlayQueue(queueRequestDto: QueueRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1202
    summary
    Request to queue items to the playlist of a SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - queueRequestDto: QueueRequestDto
      The items to add.
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlayReady:function
  - syncPlayReady(readyRequestDto: ReadyRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1212
    summary
    Notify SyncPlay group that member is ready for playback.
    
    throws
    {RequiredError}
    
    Parameters
    - readyRequestDto: ReadyRequestDto
      The player status.
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlayRemoveFromPlaylist:function
  - syncPlayRemoveFromPlaylist(removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1222
    summary
    Request to remove items from the playlist in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto
      The items to remove.
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlaySeek:function
  - syncPlaySeek(seekRequestDto: SeekRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1232
    summary
    Request seek in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - seekRequestDto: SeekRequestDto
      The new playback position.
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlaySetIgnoreWait:function
  - syncPlaySetIgnoreWait(ignoreWaitRequestDto: IgnoreWaitRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1242
    summary
    Request SyncPlay group to ignore member during group-wait.
    
    throws
    {RequiredError}
    
    Parameters
    - ignoreWaitRequestDto: IgnoreWaitRequestDto
      The settings to set.
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlaySetNewQueue:function
  - syncPlaySetNewQueue(playRequestDto: PlayRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1252
    summary
    Request to set new playlist in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - playRequestDto: PlayRequestDto
      The new playlist to play in the group.
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlaySetPlaylistItem:function
  - syncPlaySetPlaylistItem(setPlaylistItemRequestDto: SetPlaylistItemRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1262
    summary
    Request to change playlist item in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - setPlaylistItemRequestDto: SetPlaylistItemRequestDto
      The new item to play.
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlaySetRepeatMode:function
  - syncPlaySetRepeatMode(setRepeatModeRequestDto: SetRepeatModeRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1272
    summary
    Request to set repeat mode in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - setRepeatModeRequestDto: SetRepeatModeRequestDto
      The new repeat mode.
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlaySetShuffleMode:function
  - syncPlaySetShuffleMode(setShuffleModeRequestDto: SetShuffleModeRequestDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1282
    summary
    Request to set shuffle mode in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - setShuffleModeRequestDto: SetShuffleModeRequestDto
      The new shuffle mode.
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlayStop:function
  - syncPlayStop(options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1291
    summary
    Request stop in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<void>
- syncPlayUnpause:function
  - syncPlayUnpause(options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/sync-play-api.ts:1300
    summary
    Request unpause in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<void>

Const SyncPlayApiFp

SyncPlayApiFp(configuration?: Configuration): { syncPlayBuffering: any; syncPlayCreateGroup: any; syncPlayGetGroups: any; syncPlayJoinGroup: any; syncPlayLeaveGroup: any; syncPlayMovePlaylistItem: any; syncPlayNextItem: any; syncPlayPause: any; syncPlayPing: any; syncPlayPreviousItem: any; syncPlayQueue: any; syncPlayReady: any; syncPlayRemoveFromPlaylist: any; syncPlaySeek: any; syncPlaySetIgnoreWait: any; syncPlaySetNewQueue: any; syncPlaySetPlaylistItem: any; syncPlaySetRepeatMode: any; syncPlaySetShuffleMode: any; syncPlayStop: any; syncPlayUnpause: any }

- Defined in generated-client/api/sync-play-api.ts:859
SyncPlayApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { syncPlayBuffering: any; syncPlayCreateGroup: any; syncPlayGetGroups: any; syncPlayJoinGroup: any; syncPlayLeaveGroup: any; syncPlayMovePlaylistItem: any; syncPlayNextItem: any; syncPlayPause: any; syncPlayPing: any; syncPlayPreviousItem: any; syncPlayQueue: any; syncPlayReady: any; syncPlayRemoveFromPlaylist: any; syncPlaySeek: any; syncPlaySetIgnoreWait: any; syncPlaySetNewQueue: any; syncPlaySetPlaylistItem: any; syncPlaySetRepeatMode: any; syncPlaySetShuffleMode: any; syncPlayStop: any; syncPlayUnpause: any }
- syncPlayBuffering:function
  - syncPlayBuffering(bufferRequestDto: BufferRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:869
    summary
    Notify SyncPlay group that member is buffering.
    
    throws
    {RequiredError}
    
    Parameters
    - bufferRequestDto: BufferRequestDto
      The player status.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlayCreateGroup:function
  - syncPlayCreateGroup(newGroupRequestDto: NewGroupRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:880
    summary
    Create a new SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - newGroupRequestDto: NewGroupRequestDto
      The settings of the new group.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlayGetGroups:function
  - syncPlayGetGroups(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupInfoDto[]>>
  - - Defined in generated-client/api/sync-play-api.ts:890
    summary
    Gets all SyncPlay groups.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupInfoDto[]>>
- syncPlayJoinGroup:function
  - syncPlayJoinGroup(joinGroupRequestDto: JoinGroupRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:901
    summary
    Join an existing SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - joinGroupRequestDto: JoinGroupRequestDto
      The group to join.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlayLeaveGroup:function
  - syncPlayLeaveGroup(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:911
    summary
    Leave the joined SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlayMovePlaylistItem:function
  - syncPlayMovePlaylistItem(movePlaylistItemRequestDto: MovePlaylistItemRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:922
    summary
    Request to move an item in the playlist in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - movePlaylistItemRequestDto: MovePlaylistItemRequestDto
      The new position for the item.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlayNextItem:function
  - syncPlayNextItem(nextItemRequestDto: NextItemRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:933
    summary
    Request next item in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - nextItemRequestDto: NextItemRequestDto
      The current item information.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlayPause:function
  - syncPlayPause(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:943
    summary
    Request pause in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlayPing:function
  - syncPlayPing(pingRequestDto: PingRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:954
    summary
    Update session ping.
    
    throws
    {RequiredError}
    
    Parameters
    - pingRequestDto: PingRequestDto
      The new ping.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlayPreviousItem:function
  - syncPlayPreviousItem(previousItemRequestDto: PreviousItemRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:965
    summary
    Request previous item in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - previousItemRequestDto: PreviousItemRequestDto
      The current item information.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlayQueue:function
  - syncPlayQueue(queueRequestDto: QueueRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:976
    summary
    Request to queue items to the playlist of a SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - queueRequestDto: QueueRequestDto
      The items to add.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlayReady:function
  - syncPlayReady(readyRequestDto: ReadyRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:987
    summary
    Notify SyncPlay group that member is ready for playback.
    
    throws
    {RequiredError}
    
    Parameters
    - readyRequestDto: ReadyRequestDto
      The player status.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlayRemoveFromPlaylist:function
  - syncPlayRemoveFromPlaylist(removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:998
    summary
    Request to remove items from the playlist in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto
      The items to remove.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlaySeek:function
  - syncPlaySeek(seekRequestDto: SeekRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:1009
    summary
    Request seek in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - seekRequestDto: SeekRequestDto
      The new playback position.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlaySetIgnoreWait:function
  - syncPlaySetIgnoreWait(ignoreWaitRequestDto: IgnoreWaitRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:1020
    summary
    Request SyncPlay group to ignore member during group-wait.
    
    throws
    {RequiredError}
    
    Parameters
    - ignoreWaitRequestDto: IgnoreWaitRequestDto
      The settings to set.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlaySetNewQueue:function
  - syncPlaySetNewQueue(playRequestDto: PlayRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:1031
    summary
    Request to set new playlist in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - playRequestDto: PlayRequestDto
      The new playlist to play in the group.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlaySetPlaylistItem:function
  - syncPlaySetPlaylistItem(setPlaylistItemRequestDto: SetPlaylistItemRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:1042
    summary
    Request to change playlist item in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - setPlaylistItemRequestDto: SetPlaylistItemRequestDto
      The new item to play.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlaySetRepeatMode:function
  - syncPlaySetRepeatMode(setRepeatModeRequestDto: SetRepeatModeRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:1053
    summary
    Request to set repeat mode in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - setRepeatModeRequestDto: SetRepeatModeRequestDto
      The new repeat mode.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlaySetShuffleMode:function
  - syncPlaySetShuffleMode(setShuffleModeRequestDto: SetShuffleModeRequestDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:1064
    summary
    Request to set shuffle mode in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - setShuffleModeRequestDto: SetShuffleModeRequestDto
      The new shuffle mode.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlayStop:function
  - syncPlayStop(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:1074
    summary
    Request stop in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- syncPlayUnpause:function
  - syncPlayUnpause(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/sync-play-api.ts:1084
    summary
    Request unpause in SyncPlay group.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const SystemApiAxiosParamCreator

SystemApiAxiosParamCreator(configuration?: Configuration): { getEndpointInfo: (options?: any) => Promise<RequestArgs>; getLogFile: (name: string, options?: any) => Promise<RequestArgs>; getPingSystem: (options?: any) => Promise<RequestArgs>; getPublicSystemInfo: (options?: any) => Promise<RequestArgs>; getServerLogs: (options?: any) => Promise<RequestArgs>; getSystemInfo: (options?: any) => Promise<RequestArgs>; getWakeOnLanInfo: (options?: any) => Promise<RequestArgs>; postPingSystem: (options?: any) => Promise<RequestArgs>; restartApplication: (options?: any) => Promise<RequestArgs>; shutdownApplication: (options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/system-api.ts:37
SystemApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getEndpointInfo: (options?: any) => Promise<RequestArgs>; getLogFile: (name: string, options?: any) => Promise<RequestArgs>; getPingSystem: (options?: any) => Promise<RequestArgs>; getPublicSystemInfo: (options?: any) => Promise<RequestArgs>; getServerLogs: (options?: any) => Promise<RequestArgs>; getSystemInfo: (options?: any) => Promise<RequestArgs>; getWakeOnLanInfo: (options?: any) => Promise<RequestArgs>; postPingSystem: (options?: any) => Promise<RequestArgs>; restartApplication: (options?: any) => Promise<RequestArgs>; shutdownApplication: (options?: any) => Promise<RequestArgs> }
- getEndpointInfo: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets information about the request endpoint.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getLogFile: (name: string, options?: any) => Promise<RequestArgs>
  - - (name: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a log file.
      
      throws
      {RequiredError}
      
      Parameters
      - name: string
        The name of the log file to get.
      - options: any = {}
      Returns Promise<RequestArgs>
- getPingSystem: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Pings the system.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getPublicSystemInfo: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets public information about the server.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getServerLogs: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets a list of available server log files.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getSystemInfo: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets information about the server.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getWakeOnLanInfo: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets wake on lan information.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- postPingSystem: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Pings the system.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- restartApplication: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Restarts the application.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- shutdownApplication: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Shuts down the application.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>

Const SystemApiFactory

SystemApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getEndpointInfo: any; getLogFile: any; getPingSystem: any; getPublicSystemInfo: any; getServerLogs: any; getSystemInfo: any; getWakeOnLanInfo: any; postPingSystem: any; restartApplication: any; shutdownApplication: any }

- Defined in generated-client/api/system-api.ts:485
SystemApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getEndpointInfo: any; getLogFile: any; getPingSystem: any; getPublicSystemInfo: any; getServerLogs: any; getSystemInfo: any; getWakeOnLanInfo: any; postPingSystem: any; restartApplication: any; shutdownApplication: any }
- getEndpointInfo:function
  - getEndpointInfo(options?: any): AxiosPromise<EndPointInfo>
  - - Defined in generated-client/api/system-api.ts:494
    summary
    Gets information about the request endpoint.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<EndPointInfo>
- getLogFile:function
  - getLogFile(name: string, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/system-api.ts:504
    summary
    Gets a log file.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      The name of the log file to get.
    - Optional options: any
    Returns AxiosPromise<any>
- getPingSystem:function
  - getPingSystem(options?: any): AxiosPromise<string>
  - - Defined in generated-client/api/system-api.ts:513
    summary
    Pings the system.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<string>
- getPublicSystemInfo:function
  - getPublicSystemInfo(options?: any): AxiosPromise<PublicSystemInfo>
  - - Defined in generated-client/api/system-api.ts:522
    summary
    Gets public information about the server.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<PublicSystemInfo>
- getServerLogs:function
  - getServerLogs(options?: any): AxiosPromise<LogFile[]>
  - - Defined in generated-client/api/system-api.ts:531
    summary
    Gets a list of available server log files.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<LogFile[]>
- getSystemInfo:function
  - getSystemInfo(options?: any): AxiosPromise<SystemInfo>
  - - Defined in generated-client/api/system-api.ts:540
    summary
    Gets information about the server.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<SystemInfo>
- getWakeOnLanInfo:function
  - getWakeOnLanInfo(options?: any): AxiosPromise<WakeOnLanInfo[]>
  - - Defined in generated-client/api/system-api.ts:549
    summary
    Gets wake on lan information.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<WakeOnLanInfo[]>
- postPingSystem:function
  - postPingSystem(options?: any): AxiosPromise<string>
  - - Defined in generated-client/api/system-api.ts:558
    summary
    Pings the system.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<string>
- restartApplication:function
  - restartApplication(options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/system-api.ts:567
    summary
    Restarts the application.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<void>
- shutdownApplication:function
  - shutdownApplication(options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/system-api.ts:576
    summary
    Shuts down the application.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<void>

Const SystemApiFp

SystemApiFp(configuration?: Configuration): { getEndpointInfo: any; getLogFile: any; getPingSystem: any; getPublicSystemInfo: any; getServerLogs: any; getSystemInfo: any; getWakeOnLanInfo: any; postPingSystem: any; restartApplication: any; shutdownApplication: any }

- Defined in generated-client/api/system-api.ts:374
SystemApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getEndpointInfo: any; getLogFile: any; getPingSystem: any; getPublicSystemInfo: any; getServerLogs: any; getSystemInfo: any; getWakeOnLanInfo: any; postPingSystem: any; restartApplication: any; shutdownApplication: any }
- getEndpointInfo:function
  - getEndpointInfo(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndPointInfo>>
  - - Defined in generated-client/api/system-api.ts:383
    summary
    Gets information about the request endpoint.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndPointInfo>>
- getLogFile:function
  - getLogFile(name: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/system-api.ts:394
    summary
    Gets a log file.
    
    throws
    {RequiredError}
    
    Parameters
    - name: string
      The name of the log file to get.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getPingSystem:function
  - getPingSystem(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
  - - Defined in generated-client/api/system-api.ts:404
    summary
    Pings the system.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
- getPublicSystemInfo:function
  - getPublicSystemInfo(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSystemInfo>>
  - - Defined in generated-client/api/system-api.ts:414
    summary
    Gets public information about the server.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSystemInfo>>
- getServerLogs:function
  - getServerLogs(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogFile[]>>
  - - Defined in generated-client/api/system-api.ts:424
    summary
    Gets a list of available server log files.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LogFile[]>>
- getSystemInfo:function
  - getSystemInfo(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SystemInfo>>
  - - Defined in generated-client/api/system-api.ts:434
    summary
    Gets information about the server.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SystemInfo>>
- getWakeOnLanInfo:function
  - getWakeOnLanInfo(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WakeOnLanInfo[]>>
  - - Defined in generated-client/api/system-api.ts:444
    summary
    Gets wake on lan information.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WakeOnLanInfo[]>>
- postPingSystem:function
  - postPingSystem(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
  - - Defined in generated-client/api/system-api.ts:454
    summary
    Pings the system.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>
- restartApplication:function
  - restartApplication(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/system-api.ts:464
    summary
    Restarts the application.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- shutdownApplication:function
  - shutdownApplication(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/system-api.ts:474
    summary
    Shuts down the application.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const TimeSyncApiAxiosParamCreator

TimeSyncApiAxiosParamCreator(configuration?: Configuration): { getUtcTime: (options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/time-sync-api.ts:29
TimeSyncApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getUtcTime: (options?: any) => Promise<RequestArgs> }
- getUtcTime: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets the current UTC time.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>

Const TimeSyncApiFactory

TimeSyncApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getUtcTime: any }

- Defined in generated-client/api/time-sync-api.ts:88
TimeSyncApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getUtcTime: any }
- getUtcTime:function
  - getUtcTime(options?: any): AxiosPromise<UtcTimeResponse>
  - - Defined in generated-client/api/time-sync-api.ts:97
    summary
    Gets the current UTC time.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<UtcTimeResponse>

Const TimeSyncApiFp

TimeSyncApiFp(configuration?: Configuration): { getUtcTime: any }

- Defined in generated-client/api/time-sync-api.ts:68
TimeSyncApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getUtcTime: any }
- getUtcTime:function
  - getUtcTime(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UtcTimeResponse>>
  - - Defined in generated-client/api/time-sync-api.ts:77
    summary
    Gets the current UTC time.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UtcTimeResponse>>

Const TrailersApiAxiosParamCreator

TrailersApiAxiosParamCreator(configuration?: Configuration): { getTrailers: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/trailers-api.ts:43
TrailersApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getTrailers: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs> }
- getTrailers: (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>
  - - (userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Finds movies and trailers similar to a given trailer.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional userId: string
      - Optional maxOfficialRating: string
      - Optional hasThemeSong: boolean
      - Optional hasThemeVideo: boolean
      - Optional hasSubtitles: boolean
      - Optional hasSpecialFeature: boolean
      - Optional hasTrailer: boolean
      - Optional adjacentTo: string
      - Optional parentIndexNumber: number
      - Optional hasParentalRating: boolean
      - Optional isHd: boolean
      - Optional is4K: boolean
      - Optional locationTypes: LocationType[]
      - Optional excludeLocationTypes: LocationType[]
      - Optional isMissing: boolean
      - Optional isUnaired: boolean
      - Optional minCommunityRating: number
      - Optional minCriticRating: number
      - Optional minPremiereDate: string
      - Optional minDateLastSaved: string
      - Optional minDateLastSavedForUser: string
      - Optional maxPremiereDate: string
      - Optional hasOverview: boolean
      - Optional hasImdbId: boolean
      - Optional hasTmdbId: boolean
      - Optional hasTvdbId: boolean
      - Optional excludeItemIds: string[]
      - Optional startIndex: number
      - Optional limit: number
      - Optional recursive: boolean
      - Optional searchTerm: string
      - Optional sortOrder: SortOrder[]
      - Optional parentId: string
      - Optional fields: ItemFields[]
      - Optional excludeItemTypes: string[]
      - Optional filters: ItemFilter[]
      - Optional isFavorite: boolean
      - Optional mediaTypes: string[]
      - Optional imageTypes: ImageType[]
      - Optional sortBy: string[]
      - Optional isPlayed: boolean
      - Optional genres: string[]
      - Optional officialRatings: string[]
      - Optional tags: string[]
      - Optional years: number[]
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional person: string
      - Optional personIds: string[]
      - Optional personTypes: string[]
      - Optional studios: string[]
      - Optional artists: string[]
      - Optional excludeArtistIds: string[]
      - Optional artistIds: string[]
      - Optional albumArtistIds: string[]
      - Optional contributingArtistIds: string[]
      - Optional albums: string[]
      - Optional albumIds: string[]
      - Optional ids: string[]
      - Optional videoTypes: VideoType[]
      - Optional minOfficialRating: string
      - Optional isLocked: boolean
      - Optional isPlaceHolder: boolean
      - Optional hasOfficialRating: boolean
      - Optional collapseBoxSetItems: boolean
      - Optional minWidth: number
      - Optional minHeight: number
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional is3D: boolean
      - Optional seriesStatus: SeriesStatus[]
      - Optional nameStartsWithOrGreater: string
      - Optional nameStartsWith: string
      - Optional nameLessThan: string
      - Optional studioIds: string[]
      - Optional genreIds: string[]
      - Optional enableTotalRecordCount: boolean
      - Optional enableImages: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const TrailersApiFactory

TrailersApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getTrailers: any }

- Defined in generated-client/api/trailers-api.ts:587
TrailersApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getTrailers: any }
- getTrailers:function
  - getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/trailers-api.ts:675
    summary
    Finds movies and trailers similar to a given trailer.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional maxOfficialRating: string
    - Optional hasThemeSong: boolean
    - Optional hasThemeVideo: boolean
    - Optional hasSubtitles: boolean
    - Optional hasSpecialFeature: boolean
    - Optional hasTrailer: boolean
    - Optional adjacentTo: string
    - Optional parentIndexNumber: number
    - Optional hasParentalRating: boolean
    - Optional isHd: boolean
    - Optional is4K: boolean
    - Optional locationTypes: LocationType[]
    - Optional excludeLocationTypes: LocationType[]
    - Optional isMissing: boolean
    - Optional isUnaired: boolean
    - Optional minCommunityRating: number
    - Optional minCriticRating: number
    - Optional minPremiereDate: string
    - Optional minDateLastSaved: string
    - Optional minDateLastSavedForUser: string
    - Optional maxPremiereDate: string
    - Optional hasOverview: boolean
    - Optional hasImdbId: boolean
    - Optional hasTmdbId: boolean
    - Optional hasTvdbId: boolean
    - Optional excludeItemIds: string[]
    - Optional startIndex: number
    - Optional limit: number
    - Optional recursive: boolean
    - Optional searchTerm: string
    - Optional sortOrder: SortOrder[]
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional filters: ItemFilter[]
    - Optional isFavorite: boolean
    - Optional mediaTypes: string[]
    - Optional imageTypes: ImageType[]
    - Optional sortBy: string[]
    - Optional isPlayed: boolean
    - Optional genres: string[]
    - Optional officialRatings: string[]
    - Optional tags: string[]
    - Optional years: number[]
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional person: string
    - Optional personIds: string[]
    - Optional personTypes: string[]
    - Optional studios: string[]
    - Optional artists: string[]
    - Optional excludeArtistIds: string[]
    - Optional artistIds: string[]
    - Optional albumArtistIds: string[]
    - Optional contributingArtistIds: string[]
    - Optional albums: string[]
    - Optional albumIds: string[]
    - Optional ids: string[]
    - Optional videoTypes: VideoType[]
    - Optional minOfficialRating: string
    - Optional isLocked: boolean
    - Optional isPlaceHolder: boolean
    - Optional hasOfficialRating: boolean
    - Optional collapseBoxSetItems: boolean
    - Optional minWidth: number
    - Optional minHeight: number
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional is3D: boolean
    - Optional seriesStatus: SeriesStatus[]
    - Optional nameStartsWithOrGreater: string
    - Optional nameStartsWith: string
    - Optional nameLessThan: string
    - Optional studioIds: string[]
    - Optional genreIds: string[]
    - Optional enableTotalRecordCount: boolean
    - Optional enableImages: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>

Const TrailersApiFp

TrailersApiFp(configuration?: Configuration): { getTrailers: any }

- Defined in generated-client/api/trailers-api.ts:488
TrailersApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getTrailers: any }
- getTrailers:function
  - getTrailers(userId?: string, maxOfficialRating?: string, hasThemeSong?: boolean, hasThemeVideo?: boolean, hasSubtitles?: boolean, hasSpecialFeature?: boolean, hasTrailer?: boolean, adjacentTo?: string, parentIndexNumber?: number, hasParentalRating?: boolean, isHd?: boolean, is4K?: boolean, locationTypes?: LocationType[], excludeLocationTypes?: LocationType[], isMissing?: boolean, isUnaired?: boolean, minCommunityRating?: number, minCriticRating?: number, minPremiereDate?: string, minDateLastSaved?: string, minDateLastSavedForUser?: string, maxPremiereDate?: string, hasOverview?: boolean, hasImdbId?: boolean, hasTmdbId?: boolean, hasTvdbId?: boolean, excludeItemIds?: string[], startIndex?: number, limit?: number, recursive?: boolean, searchTerm?: string, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], filters?: ItemFilter[], isFavorite?: boolean, mediaTypes?: string[], imageTypes?: ImageType[], sortBy?: string[], isPlayed?: boolean, genres?: string[], officialRatings?: string[], tags?: string[], years?: number[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], person?: string, personIds?: string[], personTypes?: string[], studios?: string[], artists?: string[], excludeArtistIds?: string[], artistIds?: string[], albumArtistIds?: string[], contributingArtistIds?: string[], albums?: string[], albumIds?: string[], ids?: string[], videoTypes?: VideoType[], minOfficialRating?: string, isLocked?: boolean, isPlaceHolder?: boolean, hasOfficialRating?: boolean, collapseBoxSetItems?: boolean, minWidth?: number, minHeight?: number, maxWidth?: number, maxHeight?: number, is3D?: boolean, seriesStatus?: SeriesStatus[], nameStartsWithOrGreater?: string, nameStartsWith?: string, nameLessThan?: string, studioIds?: string[], genreIds?: string[], enableTotalRecordCount?: boolean, enableImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/trailers-api.ts:576
    summary
    Finds movies and trailers similar to a given trailer.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional maxOfficialRating: string
    - Optional hasThemeSong: boolean
    - Optional hasThemeVideo: boolean
    - Optional hasSubtitles: boolean
    - Optional hasSpecialFeature: boolean
    - Optional hasTrailer: boolean
    - Optional adjacentTo: string
    - Optional parentIndexNumber: number
    - Optional hasParentalRating: boolean
    - Optional isHd: boolean
    - Optional is4K: boolean
    - Optional locationTypes: LocationType[]
    - Optional excludeLocationTypes: LocationType[]
    - Optional isMissing: boolean
    - Optional isUnaired: boolean
    - Optional minCommunityRating: number
    - Optional minCriticRating: number
    - Optional minPremiereDate: string
    - Optional minDateLastSaved: string
    - Optional minDateLastSavedForUser: string
    - Optional maxPremiereDate: string
    - Optional hasOverview: boolean
    - Optional hasImdbId: boolean
    - Optional hasTmdbId: boolean
    - Optional hasTvdbId: boolean
    - Optional excludeItemIds: string[]
    - Optional startIndex: number
    - Optional limit: number
    - Optional recursive: boolean
    - Optional searchTerm: string
    - Optional sortOrder: SortOrder[]
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional filters: ItemFilter[]
    - Optional isFavorite: boolean
    - Optional mediaTypes: string[]
    - Optional imageTypes: ImageType[]
    - Optional sortBy: string[]
    - Optional isPlayed: boolean
    - Optional genres: string[]
    - Optional officialRatings: string[]
    - Optional tags: string[]
    - Optional years: number[]
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional person: string
    - Optional personIds: string[]
    - Optional personTypes: string[]
    - Optional studios: string[]
    - Optional artists: string[]
    - Optional excludeArtistIds: string[]
    - Optional artistIds: string[]
    - Optional albumArtistIds: string[]
    - Optional contributingArtistIds: string[]
    - Optional albums: string[]
    - Optional albumIds: string[]
    - Optional ids: string[]
    - Optional videoTypes: VideoType[]
    - Optional minOfficialRating: string
    - Optional isLocked: boolean
    - Optional isPlaceHolder: boolean
    - Optional hasOfficialRating: boolean
    - Optional collapseBoxSetItems: boolean
    - Optional minWidth: number
    - Optional minHeight: number
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional is3D: boolean
    - Optional seriesStatus: SeriesStatus[]
    - Optional nameStartsWithOrGreater: string
    - Optional nameStartsWith: string
    - Optional nameLessThan: string
    - Optional studioIds: string[]
    - Optional genreIds: string[]
    - Optional enableTotalRecordCount: boolean
    - Optional enableImages: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>

Const TvShowsApiAxiosParamCreator

TvShowsApiAxiosParamCreator(configuration?: Configuration): { getEpisodes: (seriesId: string, userId?: string, fields?: ItemFields[], season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, sortBy?: string, options?: any) => Promise<RequestArgs>; getNextUp: (userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], seriesId?: string, parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, options?: any) => Promise<RequestArgs>; getSeasons: (seriesId: string, userId?: string, fields?: ItemFields[], isSpecialSeason?: boolean, isMissing?: boolean, adjacentTo?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any) => Promise<RequestArgs>; getUpcomingEpisodes: (userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/tv-shows-api.ts:35
TvShowsApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getEpisodes: (seriesId: string, userId?: string, fields?: ItemFields[], season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, sortBy?: string, options?: any) => Promise<RequestArgs>; getNextUp: (userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], seriesId?: string, parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, options?: any) => Promise<RequestArgs>; getSeasons: (seriesId: string, userId?: string, fields?: ItemFields[], isSpecialSeason?: boolean, isMissing?: boolean, adjacentTo?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any) => Promise<RequestArgs>; getUpcomingEpisodes: (userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any) => Promise<RequestArgs> }
- getEpisodes: (seriesId: string, userId?: string, fields?: ItemFields[], season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, sortBy?: string, options?: any) => Promise<RequestArgs>
  - - (seriesId: string, userId?: string, fields?: ItemFields[], season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, sortBy?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets episodes for a tv season.
      
      throws
      {RequiredError}
      
      Parameters
      - seriesId: string
        The series id.
      - Optional userId: string
      - Optional fields: ItemFields[]
      - Optional season: number
      - Optional seasonId: string
      - Optional isMissing: boolean
      - Optional adjacentTo: string
      - Optional startItemId: string
      - Optional startIndex: number
      - Optional limit: number
      - Optional enableImages: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional enableUserData: boolean
      - Optional sortBy: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getNextUp: (userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], seriesId?: string, parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, options?: any) => Promise<RequestArgs>
  - - (userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], seriesId?: string, parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets a list of next up episodes.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional userId: string
      - Optional startIndex: number
      - Optional limit: number
      - Optional fields: ItemFields[]
      - Optional seriesId: string
      - Optional parentId: string
      - Optional enableImges: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional enableUserData: boolean
      - Optional enableTotalRecordCount: boolean
      - Optional disableFirstEpisode: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getSeasons: (seriesId: string, userId?: string, fields?: ItemFields[], isSpecialSeason?: boolean, isMissing?: boolean, adjacentTo?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any) => Promise<RequestArgs>
  - - (seriesId: string, userId?: string, fields?: ItemFields[], isSpecialSeason?: boolean, isMissing?: boolean, adjacentTo?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets seasons for a tv series.
      
      throws
      {RequiredError}
      
      Parameters
      - seriesId: string
        The series id.
      - Optional userId: string
      - Optional fields: ItemFields[]
      - Optional isSpecialSeason: boolean
      - Optional isMissing: boolean
      - Optional adjacentTo: string
      - Optional enableImages: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional enableUserData: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getUpcomingEpisodes: (userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any) => Promise<RequestArgs>
  - - (userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets a list of upcoming episodes.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional userId: string
      - Optional startIndex: number
      - Optional limit: number
      - Optional fields: ItemFields[]
      - Optional parentId: string
      - Optional enableImges: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional enableUserData: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const TvShowsApiFactory

TvShowsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getEpisodes: any; getNextUp: any; getSeasons: any; getUpcomingEpisodes: any }

- Defined in generated-client/api/tv-shows-api.ts:500
TvShowsApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getEpisodes: any; getNextUp: any; getSeasons: any; getUpcomingEpisodes: any }
- getEpisodes:function
  - getEpisodes(seriesId: string, userId?: string, fields?: ItemFields[], season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, sortBy?: string, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/tv-shows-api.ts:524
    summary
    Gets episodes for a tv season.
    
    throws
    {RequiredError}
    
    Parameters
    - seriesId: string
      The series id.
    - Optional userId: string
    - Optional fields: ItemFields[]
    - Optional season: number
    - Optional seasonId: string
    - Optional isMissing: boolean
    - Optional adjacentTo: string
    - Optional startItemId: string
    - Optional startIndex: number
    - Optional limit: number
    - Optional enableImages: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional enableUserData: boolean
    - Optional sortBy: string
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getNextUp:function
  - getNextUp(userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], seriesId?: string, parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/tv-shows-api.ts:545
    summary
    Gets a list of next up episodes.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional startIndex: number
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional seriesId: string
    - Optional parentId: string
    - Optional enableImges: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional enableUserData: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional disableFirstEpisode: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getSeasons:function
  - getSeasons(seriesId: string, userId?: string, fields?: ItemFields[], isSpecialSeason?: boolean, isMissing?: boolean, adjacentTo?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/tv-shows-api.ts:564
    summary
    Gets seasons for a tv series.
    
    throws
    {RequiredError}
    
    Parameters
    - seriesId: string
      The series id.
    - Optional userId: string
    - Optional fields: ItemFields[]
    - Optional isSpecialSeason: boolean
    - Optional isMissing: boolean
    - Optional adjacentTo: string
    - Optional enableImages: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional enableUserData: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getUpcomingEpisodes:function
  - getUpcomingEpisodes(userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/tv-shows-api.ts:582
    summary
    Gets a list of upcoming episodes.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional startIndex: number
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional parentId: string
    - Optional enableImges: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional enableUserData: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>

Const TvShowsApiFp

TvShowsApiFp(configuration?: Configuration): { getEpisodes: any; getNextUp: any; getSeasons: any; getUpcomingEpisodes: any }

- Defined in generated-client/api/tv-shows-api.ts:404
TvShowsApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getEpisodes: any; getNextUp: any; getSeasons: any; getUpcomingEpisodes: any }
- getEpisodes:function
  - getEpisodes(seriesId: string, userId?: string, fields?: ItemFields[], season?: number, seasonId?: string, isMissing?: boolean, adjacentTo?: string, startItemId?: string, startIndex?: number, limit?: number, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, sortBy?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/tv-shows-api.ts:428
    summary
    Gets episodes for a tv season.
    
    throws
    {RequiredError}
    
    Parameters
    - seriesId: string
      The series id.
    - Optional userId: string
    - Optional fields: ItemFields[]
    - Optional season: number
    - Optional seasonId: string
    - Optional isMissing: boolean
    - Optional adjacentTo: string
    - Optional startItemId: string
    - Optional startIndex: number
    - Optional limit: number
    - Optional enableImages: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional enableUserData: boolean
    - Optional sortBy: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getNextUp:function
  - getNextUp(userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], seriesId?: string, parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, enableTotalRecordCount?: boolean, disableFirstEpisode?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/tv-shows-api.ts:450
    summary
    Gets a list of next up episodes.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional startIndex: number
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional seriesId: string
    - Optional parentId: string
    - Optional enableImges: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional enableUserData: boolean
    - Optional enableTotalRecordCount: boolean
    - Optional disableFirstEpisode: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getSeasons:function
  - getSeasons(seriesId: string, userId?: string, fields?: ItemFields[], isSpecialSeason?: boolean, isMissing?: boolean, adjacentTo?: string, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/tv-shows-api.ts:470
    summary
    Gets seasons for a tv series.
    
    throws
    {RequiredError}
    
    Parameters
    - seriesId: string
      The series id.
    - Optional userId: string
    - Optional fields: ItemFields[]
    - Optional isSpecialSeason: boolean
    - Optional isMissing: boolean
    - Optional adjacentTo: string
    - Optional enableImages: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional enableUserData: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getUpcomingEpisodes:function
  - getUpcomingEpisodes(userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], parentId?: string, enableImges?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/tv-shows-api.ts:489
    summary
    Gets a list of upcoming episodes.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional userId: string
    - Optional startIndex: number
    - Optional limit: number
    - Optional fields: ItemFields[]
    - Optional parentId: string
    - Optional enableImges: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional enableUserData: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>

Const UniversalAudioApiAxiosParamCreator

UniversalAudioApiAxiosParamCreator(configuration?: Configuration): { getUniversalAudioStream: (itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any) => Promise<RequestArgs>; headUniversalAudioStream: (itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/universal-audio-api.ts:27
UniversalAudioApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getUniversalAudioStream: (itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any) => Promise<RequestArgs>; headUniversalAudioStream: (itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any) => Promise<RequestArgs> }
- getUniversalAudioStream: (itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any) => Promise<RequestArgs>
  - - (itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets an audio stream.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional container: string[]
      - Optional mediaSourceId: string
      - Optional deviceId: string
      - Optional userId: string
      - Optional audioCodec: string
      - Optional maxAudioChannels: number
      - Optional transcodingAudioChannels: number
      - Optional maxStreamingBitrate: number
      - Optional audioBitRate: number
      - Optional startTimeTicks: number
      - Optional transcodingContainer: string
      - Optional transcodingProtocol: string
      - Optional maxAudioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional enableRemoteMedia: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional enableRedirection: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- headUniversalAudioStream: (itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any) => Promise<RequestArgs>
  - - (itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets an audio stream.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional container: string[]
      - Optional mediaSourceId: string
      - Optional deviceId: string
      - Optional userId: string
      - Optional audioCodec: string
      - Optional maxAudioChannels: number
      - Optional transcodingAudioChannels: number
      - Optional maxStreamingBitrate: number
      - Optional audioBitRate: number
      - Optional startTimeTicks: number
      - Optional transcodingContainer: string
      - Optional transcodingProtocol: string
      - Optional maxAudioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional enableRemoteMedia: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional enableRedirection: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const UniversalAudioApiFactory

UniversalAudioApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getUniversalAudioStream: any; headUniversalAudioStream: any }

- Defined in generated-client/api/universal-audio-api.ts:346
UniversalAudioApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getUniversalAudioStream: any; headUniversalAudioStream: any }
- getUniversalAudioStream:function
  - getUniversalAudioStream(itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/universal-audio-api.ts:373
    summary
    Gets an audio stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional container: string[]
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional userId: string
    - Optional audioCodec: string
    - Optional maxAudioChannels: number
    - Optional transcodingAudioChannels: number
    - Optional maxStreamingBitrate: number
    - Optional audioBitRate: number
    - Optional startTimeTicks: number
    - Optional transcodingContainer: string
    - Optional transcodingProtocol: string
    - Optional maxAudioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional enableRemoteMedia: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional enableRedirection: boolean
    - Optional options: any
    Returns AxiosPromise<any>
- headUniversalAudioStream:function
  - headUniversalAudioStream(itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/universal-audio-api.ts:400
    summary
    Gets an audio stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional container: string[]
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional userId: string
    - Optional audioCodec: string
    - Optional maxAudioChannels: number
    - Optional transcodingAudioChannels: number
    - Optional maxStreamingBitrate: number
    - Optional audioBitRate: number
    - Optional startTimeTicks: number
    - Optional transcodingContainer: string
    - Optional transcodingProtocol: string
    - Optional maxAudioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional enableRemoteMedia: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional enableRedirection: boolean
    - Optional options: any
    Returns AxiosPromise<any>

Const UniversalAudioApiFp

UniversalAudioApiFp(configuration?: Configuration): { getUniversalAudioStream: any; headUniversalAudioStream: any }

- Defined in generated-client/api/universal-audio-api.ts:280
UniversalAudioApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getUniversalAudioStream: any; headUniversalAudioStream: any }
- getUniversalAudioStream:function
  - getUniversalAudioStream(itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/universal-audio-api.ts:307
    summary
    Gets an audio stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional container: string[]
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional userId: string
    - Optional audioCodec: string
    - Optional maxAudioChannels: number
    - Optional transcodingAudioChannels: number
    - Optional maxStreamingBitrate: number
    - Optional audioBitRate: number
    - Optional startTimeTicks: number
    - Optional transcodingContainer: string
    - Optional transcodingProtocol: string
    - Optional maxAudioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional enableRemoteMedia: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional enableRedirection: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headUniversalAudioStream:function
  - headUniversalAudioStream(itemId: string, container?: string[], mediaSourceId?: string, deviceId?: string, userId?: string, audioCodec?: string, maxAudioChannels?: number, transcodingAudioChannels?: number, maxStreamingBitrate?: number, audioBitRate?: number, startTimeTicks?: number, transcodingContainer?: string, transcodingProtocol?: string, maxAudioSampleRate?: number, maxAudioBitDepth?: number, enableRemoteMedia?: boolean, breakOnNonKeyFrames?: boolean, enableRedirection?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/universal-audio-api.ts:335
    summary
    Gets an audio stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional container: string[]
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional userId: string
    - Optional audioCodec: string
    - Optional maxAudioChannels: number
    - Optional transcodingAudioChannels: number
    - Optional maxStreamingBitrate: number
    - Optional audioBitRate: number
    - Optional startTimeTicks: number
    - Optional transcodingContainer: string
    - Optional transcodingProtocol: string
    - Optional maxAudioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional enableRemoteMedia: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional enableRedirection: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

Const UserApiAxiosParamCreator

UserApiAxiosParamCreator(configuration?: Configuration): { authenticateUser: (userId: string, pw: string, password?: string, options?: any) => Promise<RequestArgs>; authenticateUserByName: (authenticateUserByName: AuthenticateUserByName, options?: any) => Promise<RequestArgs>; authenticateWithQuickConnect: (quickConnectDto: QuickConnectDto, options?: any) => Promise<RequestArgs>; createUserByName: (createUserByName: CreateUserByName, options?: any) => Promise<RequestArgs>; deleteUser: (userId: string, options?: any) => Promise<RequestArgs>; forgotPassword: (forgotPasswordDto: ForgotPasswordDto, options?: any) => Promise<RequestArgs>; forgotPasswordPin: (forgotPasswordPinDto: ForgotPasswordPinDto, options?: any) => Promise<RequestArgs>; getCurrentUser: (options?: any) => Promise<RequestArgs>; getPublicUsers: (options?: any) => Promise<RequestArgs>; getUserById: (userId: string, options?: any) => Promise<RequestArgs>; getUsers: (isHidden?: boolean, isDisabled?: boolean, options?: any) => Promise<RequestArgs>; updateUser: (userId: string, userDto: UserDto, options?: any) => Promise<RequestArgs>; updateUserConfiguration: (userId: string, userConfiguration: UserConfiguration, options?: any) => Promise<RequestArgs>; updateUserEasyPassword: (userId: string, updateUserEasyPassword: UpdateUserEasyPassword, options?: any) => Promise<RequestArgs>; updateUserPassword: (userId: string, updateUserPassword: UpdateUserPassword, options?: any) => Promise<RequestArgs>; updateUserPolicy: (userId: string, userPolicy: UserPolicy, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/user-api.ts:55
UserApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { authenticateUser: (userId: string, pw: string, password?: string, options?: any) => Promise<RequestArgs>; authenticateUserByName: (authenticateUserByName: AuthenticateUserByName, options?: any) => Promise<RequestArgs>; authenticateWithQuickConnect: (quickConnectDto: QuickConnectDto, options?: any) => Promise<RequestArgs>; createUserByName: (createUserByName: CreateUserByName, options?: any) => Promise<RequestArgs>; deleteUser: (userId: string, options?: any) => Promise<RequestArgs>; forgotPassword: (forgotPasswordDto: ForgotPasswordDto, options?: any) => Promise<RequestArgs>; forgotPasswordPin: (forgotPasswordPinDto: ForgotPasswordPinDto, options?: any) => Promise<RequestArgs>; getCurrentUser: (options?: any) => Promise<RequestArgs>; getPublicUsers: (options?: any) => Promise<RequestArgs>; getUserById: (userId: string, options?: any) => Promise<RequestArgs>; getUsers: (isHidden?: boolean, isDisabled?: boolean, options?: any) => Promise<RequestArgs>; updateUser: (userId: string, userDto: UserDto, options?: any) => Promise<RequestArgs>; updateUserConfiguration: (userId: string, userConfiguration: UserConfiguration, options?: any) => Promise<RequestArgs>; updateUserEasyPassword: (userId: string, updateUserEasyPassword: UpdateUserEasyPassword, options?: any) => Promise<RequestArgs>; updateUserPassword: (userId: string, updateUserPassword: UpdateUserPassword, options?: any) => Promise<RequestArgs>; updateUserPolicy: (userId: string, userPolicy: UserPolicy, options?: any) => Promise<RequestArgs> }
- authenticateUser: (userId: string, pw: string, password?: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, pw: string, password?: string, options?: any): Promise<RequestArgs>
    - summary
      Authenticates a user.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        The user id.
      - pw: string
        The password as plain text.
      - Optional password: string
      - options: any = {}
      Returns Promise<RequestArgs>
- authenticateUserByName: (authenticateUserByName: AuthenticateUserByName, options?: any) => Promise<RequestArgs>
  - - (authenticateUserByName: AuthenticateUserByName, options?: any): Promise<RequestArgs>
    - summary
      Authenticates a user by name.
      
      throws
      {RequiredError}
      
      Parameters
      - authenticateUserByName: AuthenticateUserByName
        The M:Jellyfin.Api.Controllers.UserController.AuthenticateUserByName(Jellyfin.Api.Models.UserDtos.AuthenticateUserByName) request.
      - options: any = {}
      Returns Promise<RequestArgs>
- authenticateWithQuickConnect: (quickConnectDto: QuickConnectDto, options?: any) => Promise<RequestArgs>
  - - (quickConnectDto: QuickConnectDto, options?: any): Promise<RequestArgs>
    - summary
      Authenticates a user with quick connect.
      
      throws
      {RequiredError}
      
      Parameters
      - quickConnectDto: QuickConnectDto
        The Jellyfin.Api.Models.UserDtos.QuickConnectDto request.
      - options: any = {}
      Returns Promise<RequestArgs>
- createUserByName: (createUserByName: CreateUserByName, options?: any) => Promise<RequestArgs>
  - - (createUserByName: CreateUserByName, options?: any): Promise<RequestArgs>
    - summary
      Creates a user.
      
      throws
      {RequiredError}
      
      Parameters
      - createUserByName: CreateUserByName
        The create user by name request body.
      - options: any = {}
      Returns Promise<RequestArgs>
- deleteUser: (userId: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, options?: any): Promise<RequestArgs>
    - summary
      Deletes a user.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        The user id.
      - options: any = {}
      Returns Promise<RequestArgs>
- forgotPassword: (forgotPasswordDto: ForgotPasswordDto, options?: any) => Promise<RequestArgs>
  - - (forgotPasswordDto: ForgotPasswordDto, options?: any): Promise<RequestArgs>
    - summary
      Initiates the forgot password process for a local user.
      
      throws
      {RequiredError}
      
      Parameters
      - forgotPasswordDto: ForgotPasswordDto
        The forgot password request containing the entered username.
      - options: any = {}
      Returns Promise<RequestArgs>
- forgotPasswordPin: (forgotPasswordPinDto: ForgotPasswordPinDto, options?: any) => Promise<RequestArgs>
  - - (forgotPasswordPinDto: ForgotPasswordPinDto, options?: any): Promise<RequestArgs>
    - summary
      Redeems a forgot password pin.
      
      throws
      {RequiredError}
      
      Parameters
      - forgotPasswordPinDto: ForgotPasswordPinDto
        The forgot password pin request containing the entered pin.
      - options: any = {}
      Returns Promise<RequestArgs>
- getCurrentUser: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets the user based on auth token.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getPublicUsers: (options?: any) => Promise<RequestArgs>
  - - (options?: any): Promise<RequestArgs>
    - summary
      Gets a list of publicly visible users for display on a login screen.
      
      throws
      {RequiredError}
      
      Parameters
      - options: any = {}
      Returns Promise<RequestArgs>
- getUserById: (userId: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a user by Id.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        The user id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getUsers: (isHidden?: boolean, isDisabled?: boolean, options?: any) => Promise<RequestArgs>
  - - (isHidden?: boolean, isDisabled?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets a list of users.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional isHidden: boolean
      - Optional isDisabled: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- updateUser: (userId: string, userDto: UserDto, options?: any) => Promise<RequestArgs>
  - - (userId: string, userDto: UserDto, options?: any): Promise<RequestArgs>
    - summary
      Updates a user.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        The user id.
      - userDto: UserDto
        The updated user model.
      - options: any = {}
      Returns Promise<RequestArgs>
- updateUserConfiguration: (userId: string, userConfiguration: UserConfiguration, options?: any) => Promise<RequestArgs>
  - - (userId: string, userConfiguration: UserConfiguration, options?: any): Promise<RequestArgs>
    - summary
      Updates a user configuration.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        The user id.
      - userConfiguration: UserConfiguration
        The new user configuration.
      - options: any = {}
      Returns Promise<RequestArgs>
- updateUserEasyPassword: (userId: string, updateUserEasyPassword: UpdateUserEasyPassword, options?: any) => Promise<RequestArgs>
  - - (userId: string, updateUserEasyPassword: UpdateUserEasyPassword, options?: any): Promise<RequestArgs>
    - summary
      Updates a user's easy password.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        The user id.
      - updateUserEasyPassword: UpdateUserEasyPassword
        The M:Jellyfin.Api.Controllers.UserController.UpdateUserEasyPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserEasyPassword) request.
      - options: any = {}
      Returns Promise<RequestArgs>
- updateUserPassword: (userId: string, updateUserPassword: UpdateUserPassword, options?: any) => Promise<RequestArgs>
  - - (userId: string, updateUserPassword: UpdateUserPassword, options?: any): Promise<RequestArgs>
    - summary
      Updates a user's password.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        The user id.
      - updateUserPassword: UpdateUserPassword
        The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request.
      - options: any = {}
      Returns Promise<RequestArgs>
- updateUserPolicy: (userId: string, userPolicy: UserPolicy, options?: any) => Promise<RequestArgs>
  - - (userId: string, userPolicy: UserPolicy, options?: any): Promise<RequestArgs>
    - summary
      Updates a user policy.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        The user id.
      - userPolicy: UserPolicy
        The new user policy.
      - options: any = {}
      Returns Promise<RequestArgs>

Const UserApiFactory

UserApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { authenticateUser: any; authenticateUserByName: any; authenticateWithQuickConnect: any; createUserByName: any; deleteUser: any; forgotPassword: any; forgotPasswordPin: any; getCurrentUser: any; getPublicUsers: any; getUserById: any; getUsers: any; updateUser: any; updateUserConfiguration: any; updateUserEasyPassword: any; updateUserPassword: any; updateUserPolicy: any }

- Defined in generated-client/api/user-api.ts:880
UserApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { authenticateUser: any; authenticateUserByName: any; authenticateWithQuickConnect: any; createUserByName: any; deleteUser: any; forgotPassword: any; forgotPasswordPin: any; getCurrentUser: any; getPublicUsers: any; getUserById: any; getUsers: any; updateUser: any; updateUserConfiguration: any; updateUserEasyPassword: any; updateUserPassword: any; updateUserPolicy: any }
- authenticateUser:function
  - authenticateUser(userId: string, pw: string, password?: string, options?: any): AxiosPromise<AuthenticationResult>
  - - Defined in generated-client/api/user-api.ts:892
    summary
    Authenticates a user.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - pw: string
      The password as plain text.
    - Optional password: string
    - Optional options: any
    Returns AxiosPromise<AuthenticationResult>
- authenticateUserByName:function
  - authenticateUserByName(authenticateUserByName: AuthenticateUserByName, options?: any): AxiosPromise<AuthenticationResult>
  - - Defined in generated-client/api/user-api.ts:902
    summary
    Authenticates a user by name.
    
    throws
    {RequiredError}
    
    Parameters
    - authenticateUserByName: AuthenticateUserByName
      The M:Jellyfin.Api.Controllers.UserController.AuthenticateUserByName(Jellyfin.Api.Models.UserDtos.AuthenticateUserByName) request.
    - Optional options: any
    Returns AxiosPromise<AuthenticationResult>
- authenticateWithQuickConnect:function
  - authenticateWithQuickConnect(quickConnectDto: QuickConnectDto, options?: any): AxiosPromise<AuthenticationResult>
  - - Defined in generated-client/api/user-api.ts:912
    summary
    Authenticates a user with quick connect.
    
    throws
    {RequiredError}
    
    Parameters
    - quickConnectDto: QuickConnectDto
      The Jellyfin.Api.Models.UserDtos.QuickConnectDto request.
    - Optional options: any
    Returns AxiosPromise<AuthenticationResult>
- createUserByName:function
  - createUserByName(createUserByName: CreateUserByName, options?: any): AxiosPromise<UserDto>
  - - Defined in generated-client/api/user-api.ts:922
    summary
    Creates a user.
    
    throws
    {RequiredError}
    
    Parameters
    - createUserByName: CreateUserByName
      The create user by name request body.
    - Optional options: any
    Returns AxiosPromise<UserDto>
- deleteUser:function
  - deleteUser(userId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/user-api.ts:932
    summary
    Deletes a user.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - Optional options: any
    Returns AxiosPromise<void>
- forgotPassword:function
  - forgotPassword(forgotPasswordDto: ForgotPasswordDto, options?: any): AxiosPromise<ForgotPasswordResult>
  - - Defined in generated-client/api/user-api.ts:942
    summary
    Initiates the forgot password process for a local user.
    
    throws
    {RequiredError}
    
    Parameters
    - forgotPasswordDto: ForgotPasswordDto
      The forgot password request containing the entered username.
    - Optional options: any
    Returns AxiosPromise<ForgotPasswordResult>
- forgotPasswordPin:function
  - forgotPasswordPin(forgotPasswordPinDto: ForgotPasswordPinDto, options?: any): AxiosPromise<PinRedeemResult>
  - - Defined in generated-client/api/user-api.ts:952
    summary
    Redeems a forgot password pin.
    
    throws
    {RequiredError}
    
    Parameters
    - forgotPasswordPinDto: ForgotPasswordPinDto
      The forgot password pin request containing the entered pin.
    - Optional options: any
    Returns AxiosPromise<PinRedeemResult>
- getCurrentUser:function
  - getCurrentUser(options?: any): AxiosPromise<UserDto>
  - - Defined in generated-client/api/user-api.ts:961
    summary
    Gets the user based on auth token.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<UserDto>
- getPublicUsers:function
  - getPublicUsers(options?: any): AxiosPromise<UserDto[]>
  - - Defined in generated-client/api/user-api.ts:970
    summary
    Gets a list of publicly visible users for display on a login screen.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns AxiosPromise<UserDto[]>
- getUserById:function
  - getUserById(userId: string, options?: any): AxiosPromise<UserDto>
  - - Defined in generated-client/api/user-api.ts:980
    summary
    Gets a user by Id.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - Optional options: any
    Returns AxiosPromise<UserDto>
- getUsers:function
  - getUsers(isHidden?: boolean, isDisabled?: boolean, options?: any): AxiosPromise<UserDto[]>
  - - Defined in generated-client/api/user-api.ts:991
    summary
    Gets a list of users.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional isHidden: boolean
    - Optional isDisabled: boolean
    - Optional options: any
    Returns AxiosPromise<UserDto[]>
- updateUser:function
  - updateUser(userId: string, userDto: UserDto, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/user-api.ts:1002
    summary
    Updates a user.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - userDto: UserDto
      The updated user model.
    - Optional options: any
    Returns AxiosPromise<void>
- updateUserConfiguration:function
  - updateUserConfiguration(userId: string, userConfiguration: UserConfiguration, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/user-api.ts:1013
    summary
    Updates a user configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - userConfiguration: UserConfiguration
      The new user configuration.
    - Optional options: any
    Returns AxiosPromise<void>
- updateUserEasyPassword:function
  - updateUserEasyPassword(userId: string, updateUserEasyPassword: UpdateUserEasyPassword, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/user-api.ts:1024
    summary
    Updates a user's easy password.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - updateUserEasyPassword: UpdateUserEasyPassword
      The M:Jellyfin.Api.Controllers.UserController.UpdateUserEasyPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserEasyPassword) request.
    - Optional options: any
    Returns AxiosPromise<void>
- updateUserPassword:function
  - updateUserPassword(userId: string, updateUserPassword: UpdateUserPassword, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/user-api.ts:1035
    summary
    Updates a user's password.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - updateUserPassword: UpdateUserPassword
      The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request.
    - Optional options: any
    Returns AxiosPromise<void>
- updateUserPolicy:function
  - updateUserPolicy(userId: string, userPolicy: UserPolicy, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/user-api.ts:1046
    summary
    Updates a user policy.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - userPolicy: UserPolicy
      The new user policy.
    - Optional options: any
    Returns AxiosPromise<void>

Const UserApiFp

UserApiFp(configuration?: Configuration): { authenticateUser: any; authenticateUserByName: any; authenticateWithQuickConnect: any; createUserByName: any; deleteUser: any; forgotPassword: any; forgotPasswordPin: any; getCurrentUser: any; getPublicUsers: any; getUserById: any; getUsers: any; updateUser: any; updateUserConfiguration: any; updateUserEasyPassword: any; updateUserPassword: any; updateUserPolicy: any }

- Defined in generated-client/api/user-api.ts:688
UserApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { authenticateUser: any; authenticateUserByName: any; authenticateWithQuickConnect: any; createUserByName: any; deleteUser: any; forgotPassword: any; forgotPasswordPin: any; getCurrentUser: any; getPublicUsers: any; getUserById: any; getUsers: any; updateUser: any; updateUserConfiguration: any; updateUserEasyPassword: any; updateUserPassword: any; updateUserPolicy: any }
- authenticateUser:function
  - authenticateUser(userId: string, pw: string, password?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResult>>
  - - Defined in generated-client/api/user-api.ts:700
    summary
    Authenticates a user.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - pw: string
      The password as plain text.
    - Optional password: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResult>>
- authenticateUserByName:function
  - authenticateUserByName(authenticateUserByName: AuthenticateUserByName, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResult>>
  - - Defined in generated-client/api/user-api.ts:711
    summary
    Authenticates a user by name.
    
    throws
    {RequiredError}
    
    Parameters
    - authenticateUserByName: AuthenticateUserByName
      The M:Jellyfin.Api.Controllers.UserController.AuthenticateUserByName(Jellyfin.Api.Models.UserDtos.AuthenticateUserByName) request.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResult>>
- authenticateWithQuickConnect:function
  - authenticateWithQuickConnect(quickConnectDto: QuickConnectDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResult>>
  - - Defined in generated-client/api/user-api.ts:722
    summary
    Authenticates a user with quick connect.
    
    throws
    {RequiredError}
    
    Parameters
    - quickConnectDto: QuickConnectDto
      The Jellyfin.Api.Models.UserDtos.QuickConnectDto request.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthenticationResult>>
- createUserByName:function
  - createUserByName(createUserByName: CreateUserByName, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>
  - - Defined in generated-client/api/user-api.ts:733
    summary
    Creates a user.
    
    throws
    {RequiredError}
    
    Parameters
    - createUserByName: CreateUserByName
      The create user by name request body.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>
- deleteUser:function
  - deleteUser(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/user-api.ts:744
    summary
    Deletes a user.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- forgotPassword:function
  - forgotPassword(forgotPasswordDto: ForgotPasswordDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForgotPasswordResult>>
  - - Defined in generated-client/api/user-api.ts:755
    summary
    Initiates the forgot password process for a local user.
    
    throws
    {RequiredError}
    
    Parameters
    - forgotPasswordDto: ForgotPasswordDto
      The forgot password request containing the entered username.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForgotPasswordResult>>
- forgotPasswordPin:function
  - forgotPasswordPin(forgotPasswordPinDto: ForgotPasswordPinDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PinRedeemResult>>
  - - Defined in generated-client/api/user-api.ts:766
    summary
    Redeems a forgot password pin.
    
    throws
    {RequiredError}
    
    Parameters
    - forgotPasswordPinDto: ForgotPasswordPinDto
      The forgot password pin request containing the entered pin.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PinRedeemResult>>
- getCurrentUser:function
  - getCurrentUser(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>
  - - Defined in generated-client/api/user-api.ts:776
    summary
    Gets the user based on auth token.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>
- getPublicUsers:function
  - getPublicUsers(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto[]>>
  - - Defined in generated-client/api/user-api.ts:786
    summary
    Gets a list of publicly visible users for display on a login screen.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto[]>>
- getUserById:function
  - getUserById(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>
  - - Defined in generated-client/api/user-api.ts:797
    summary
    Gets a user by Id.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>
- getUsers:function
  - getUsers(isHidden?: boolean, isDisabled?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto[]>>
  - - Defined in generated-client/api/user-api.ts:809
    summary
    Gets a list of users.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional isHidden: boolean
    - Optional isDisabled: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto[]>>
- updateUser:function
  - updateUser(userId: string, userDto: UserDto, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/user-api.ts:821
    summary
    Updates a user.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - userDto: UserDto
      The updated user model.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- updateUserConfiguration:function
  - updateUserConfiguration(userId: string, userConfiguration: UserConfiguration, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/user-api.ts:833
    summary
    Updates a user configuration.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - userConfiguration: UserConfiguration
      The new user configuration.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- updateUserEasyPassword:function
  - updateUserEasyPassword(userId: string, updateUserEasyPassword: UpdateUserEasyPassword, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/user-api.ts:845
    summary
    Updates a user's easy password.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - updateUserEasyPassword: UpdateUserEasyPassword
      The M:Jellyfin.Api.Controllers.UserController.UpdateUserEasyPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserEasyPassword) request.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- updateUserPassword:function
  - updateUserPassword(userId: string, updateUserPassword: UpdateUserPassword, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/user-api.ts:857
    summary
    Updates a user's password.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - updateUserPassword: UpdateUserPassword
      The M:Jellyfin.Api.Controllers.UserController.UpdateUserPassword(System.Guid,Jellyfin.Api.Models.UserDtos.UpdateUserPassword) request.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- updateUserPolicy:function
  - updateUserPolicy(userId: string, userPolicy: UserPolicy, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/user-api.ts:869
    summary
    Updates a user policy.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      The user id.
    - userPolicy: UserPolicy
      The new user policy.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const UserLibraryApiAxiosParamCreator

UserLibraryApiAxiosParamCreator(configuration?: Configuration): { deleteUserItemRating: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; getIntros: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; getItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; getLatestMedia: (userId: string, parentId?: string, fields?: ItemFields[], includeItemTypes?: string[], isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: any) => Promise<RequestArgs>; getLocalTrailers: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; getRootFolder: (userId: string, options?: any) => Promise<RequestArgs>; getSpecialFeatures: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; markFavoriteItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; unmarkFavoriteItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; updateUserItemRating: (userId: string, itemId: string, likes?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/user-library-api.ts:37
UserLibraryApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { deleteUserItemRating: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; getIntros: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; getItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; getLatestMedia: (userId: string, parentId?: string, fields?: ItemFields[], includeItemTypes?: string[], isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: any) => Promise<RequestArgs>; getLocalTrailers: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; getRootFolder: (userId: string, options?: any) => Promise<RequestArgs>; getSpecialFeatures: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; markFavoriteItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; unmarkFavoriteItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>; updateUserItemRating: (userId: string, itemId: string, likes?: boolean, options?: any) => Promise<RequestArgs> }
- deleteUserItemRating: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Deletes a user's saved personal rating for an item.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - itemId: string
        Item id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getIntros: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets intros to play before the main media item plays.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - itemId: string
        Item id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets an item from a user's library.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - itemId: string
        Item id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getLatestMedia: (userId: string, parentId?: string, fields?: ItemFields[], includeItemTypes?: string[], isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: any) => Promise<RequestArgs>
  - - (userId: string, parentId?: string, fields?: ItemFields[], includeItemTypes?: string[], isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets latest media.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - Optional parentId: string
      - Optional fields: ItemFields[]
      - Optional includeItemTypes: string[]
      - Optional isPlayed: boolean
      - Optional enableImages: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional enableUserData: boolean
      - Optional limit: number
      - Optional groupItems: boolean
      - options: any = {}
      Returns Promise<RequestArgs>
- getLocalTrailers: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets local trailers for an item.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - itemId: string
        Item id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getRootFolder: (userId: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets the root folder from a user's library.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getSpecialFeatures: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Gets special features for an item.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - itemId: string
        Item id.
      - options: any = {}
      Returns Promise<RequestArgs>
- markFavoriteItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Marks an item as a favorite.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - itemId: string
        Item id.
      - options: any = {}
      Returns Promise<RequestArgs>
- unmarkFavoriteItem: (userId: string, itemId: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Unmarks item as a favorite.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - itemId: string
        Item id.
      - options: any = {}
      Returns Promise<RequestArgs>
- updateUserItemRating: (userId: string, itemId: string, likes?: boolean, options?: any) => Promise<RequestArgs>
  - - (userId: string, itemId: string, likes?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Updates a user's rating for an item.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - itemId: string
        Item id.
      - Optional likes: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const UserLibraryApiFactory

UserLibraryApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { deleteUserItemRating: any; getIntros: any; getItem: any; getLatestMedia: any; getLocalTrailers: any; getRootFolder: any; getSpecialFeatures: any; markFavoriteItem: any; unmarkFavoriteItem: any; updateUserItemRating: any }

- Defined in generated-client/api/user-library-api.ts:642
UserLibraryApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { deleteUserItemRating: any; getIntros: any; getItem: any; getLatestMedia: any; getLocalTrailers: any; getRootFolder: any; getSpecialFeatures: any; markFavoriteItem: any; unmarkFavoriteItem: any; updateUserItemRating: any }
- deleteUserItemRating:function
  - deleteUserItemRating(userId: string, itemId: string, options?: any): AxiosPromise<UserItemDataDto>
  - - Defined in generated-client/api/user-library-api.ts:653
    summary
    Deletes a user's saved personal rating for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional options: any
    Returns AxiosPromise<UserItemDataDto>
- getIntros:function
  - getIntros(userId: string, itemId: string, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/user-library-api.ts:664
    summary
    Gets intros to play before the main media item plays.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getItem:function
  - getItem(userId: string, itemId: string, options?: any): AxiosPromise<BaseItemDto>
  - - Defined in generated-client/api/user-library-api.ts:675
    summary
    Gets an item from a user's library.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional options: any
    Returns AxiosPromise<BaseItemDto>
- getLatestMedia:function
  - getLatestMedia(userId: string, parentId?: string, fields?: ItemFields[], includeItemTypes?: string[], isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: any): AxiosPromise<BaseItemDto[]>
  - - Defined in generated-client/api/user-library-api.ts:695
    summary
    Gets latest media.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional includeItemTypes: string[]
    - Optional isPlayed: boolean
    - Optional enableImages: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional enableUserData: boolean
    - Optional limit: number
    - Optional groupItems: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDto[]>
- getLocalTrailers:function
  - getLocalTrailers(userId: string, itemId: string, options?: any): AxiosPromise<BaseItemDto[]>
  - - Defined in generated-client/api/user-library-api.ts:706
    summary
    Gets local trailers for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional options: any
    Returns AxiosPromise<BaseItemDto[]>
- getRootFolder:function
  - getRootFolder(userId: string, options?: any): AxiosPromise<BaseItemDto>
  - - Defined in generated-client/api/user-library-api.ts:716
    summary
    Gets the root folder from a user's library.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - Optional options: any
    Returns AxiosPromise<BaseItemDto>
- getSpecialFeatures:function
  - getSpecialFeatures(userId: string, itemId: string, options?: any): AxiosPromise<BaseItemDto[]>
  - - Defined in generated-client/api/user-library-api.ts:727
    summary
    Gets special features for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional options: any
    Returns AxiosPromise<BaseItemDto[]>
- markFavoriteItem:function
  - markFavoriteItem(userId: string, itemId: string, options?: any): AxiosPromise<UserItemDataDto>
  - - Defined in generated-client/api/user-library-api.ts:738
    summary
    Marks an item as a favorite.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional options: any
    Returns AxiosPromise<UserItemDataDto>
- unmarkFavoriteItem:function
  - unmarkFavoriteItem(userId: string, itemId: string, options?: any): AxiosPromise<UserItemDataDto>
  - - Defined in generated-client/api/user-library-api.ts:749
    summary
    Unmarks item as a favorite.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional options: any
    Returns AxiosPromise<UserItemDataDto>
- updateUserItemRating:function
  - updateUserItemRating(userId: string, itemId: string, likes?: boolean, options?: any): AxiosPromise<UserItemDataDto>
  - - Defined in generated-client/api/user-library-api.ts:761
    summary
    Updates a user's rating for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional likes: boolean
    - Optional options: any
    Returns AxiosPromise<UserItemDataDto>

Const UserLibraryApiFp

UserLibraryApiFp(configuration?: Configuration): { deleteUserItemRating: any; getIntros: any; getItem: any; getLatestMedia: any; getLocalTrailers: any; getRootFolder: any; getSpecialFeatures: any; markFavoriteItem: any; unmarkFavoriteItem: any; updateUserItemRating: any }

- Defined in generated-client/api/user-library-api.ts:503
UserLibraryApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { deleteUserItemRating: any; getIntros: any; getItem: any; getLatestMedia: any; getLocalTrailers: any; getRootFolder: any; getSpecialFeatures: any; markFavoriteItem: any; unmarkFavoriteItem: any; updateUserItemRating: any }
- deleteUserItemRating:function
  - deleteUserItemRating(userId: string, itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
  - - Defined in generated-client/api/user-library-api.ts:514
    summary
    Deletes a user's saved personal rating for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
- getIntros:function
  - getIntros(userId: string, itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/user-library-api.ts:526
    summary
    Gets intros to play before the main media item plays.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getItem:function
  - getItem(userId: string, itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
  - - Defined in generated-client/api/user-library-api.ts:538
    summary
    Gets an item from a user's library.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
- getLatestMedia:function
  - getLatestMedia(userId: string, parentId?: string, fields?: ItemFields[], includeItemTypes?: string[], isPlayed?: boolean, enableImages?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], enableUserData?: boolean, limit?: number, groupItems?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>>
  - - Defined in generated-client/api/user-library-api.ts:559
    summary
    Gets latest media.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional includeItemTypes: string[]
    - Optional isPlayed: boolean
    - Optional enableImages: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional enableUserData: boolean
    - Optional limit: number
    - Optional groupItems: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>>
- getLocalTrailers:function
  - getLocalTrailers(userId: string, itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>>
  - - Defined in generated-client/api/user-library-api.ts:571
    summary
    Gets local trailers for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>>
- getRootFolder:function
  - getRootFolder(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
  - - Defined in generated-client/api/user-library-api.ts:582
    summary
    Gets the root folder from a user's library.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
- getSpecialFeatures:function
  - getSpecialFeatures(userId: string, itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>>
  - - Defined in generated-client/api/user-library-api.ts:594
    summary
    Gets special features for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto[]>>
- markFavoriteItem:function
  - markFavoriteItem(userId: string, itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
  - - Defined in generated-client/api/user-library-api.ts:606
    summary
    Marks an item as a favorite.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
- unmarkFavoriteItem:function
  - unmarkFavoriteItem(userId: string, itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
  - - Defined in generated-client/api/user-library-api.ts:618
    summary
    Unmarks item as a favorite.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
- updateUserItemRating:function
  - updateUserItemRating(userId: string, itemId: string, likes?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>
  - - Defined in generated-client/api/user-library-api.ts:631
    summary
    Updates a user's rating for an item.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - itemId: string
      Item id.
    - Optional likes: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserItemDataDto>>

Const UserViewsApiAxiosParamCreator

UserViewsApiAxiosParamCreator(configuration?: Configuration): { getGroupingOptions: (userId: string, options?: any) => Promise<RequestArgs>; getUserViews: (userId: string, includeExternalContent?: boolean, presetViews?: string[], includeHidden?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/user-views-api.ts:33
UserViewsApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getGroupingOptions: (userId: string, options?: any) => Promise<RequestArgs>; getUserViews: (userId: string, includeExternalContent?: boolean, presetViews?: string[], includeHidden?: boolean, options?: any) => Promise<RequestArgs> }
- getGroupingOptions: (userId: string, options?: any) => Promise<RequestArgs>
  - - (userId: string, options?: any): Promise<RequestArgs>
    - summary
      Get user view grouping options.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getUserViews: (userId: string, includeExternalContent?: boolean, presetViews?: string[], includeHidden?: boolean, options?: any) => Promise<RequestArgs>
  - - (userId: string, includeExternalContent?: boolean, presetViews?: string[], includeHidden?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Get user views.
      
      throws
      {RequiredError}
      
      Parameters
      - userId: string
        User id.
      - Optional includeExternalContent: boolean
      - Optional presetViews: string[]
      - Optional includeHidden: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const UserViewsApiFactory

UserViewsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getGroupingOptions: any; getUserViews: any }

- Defined in generated-client/api/user-views-api.ts:160
UserViewsApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getGroupingOptions: any; getUserViews: any }
- getGroupingOptions:function
  - getGroupingOptions(userId: string, options?: any): AxiosPromise<SpecialViewOptionDto[]>
  - - Defined in generated-client/api/user-views-api.ts:170
    summary
    Get user view grouping options.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - Optional options: any
    Returns AxiosPromise<SpecialViewOptionDto[]>
- getUserViews:function
  - getUserViews(userId: string, includeExternalContent?: boolean, presetViews?: string[], includeHidden?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/user-views-api.ts:183
    summary
    Get user views.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - Optional includeExternalContent: boolean
    - Optional presetViews: string[]
    - Optional includeHidden: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>

Const UserViewsApiFp

UserViewsApiFp(configuration?: Configuration): { getGroupingOptions: any; getUserViews: any }

- Defined in generated-client/api/user-views-api.ts:125
UserViewsApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getGroupingOptions: any; getUserViews: any }
- getGroupingOptions:function
  - getGroupingOptions(userId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SpecialViewOptionDto[]>>
  - - Defined in generated-client/api/user-views-api.ts:135
    summary
    Get user view grouping options.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SpecialViewOptionDto[]>>
- getUserViews:function
  - getUserViews(userId: string, includeExternalContent?: boolean, presetViews?: string[], includeHidden?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/user-views-api.ts:149
    summary
    Get user views.
    
    throws
    {RequiredError}
    
    Parameters
    - userId: string
      User id.
    - Optional includeExternalContent: boolean
    - Optional presetViews: string[]
    - Optional includeHidden: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>

Const VideoAttachmentsApiAxiosParamCreator

VideoAttachmentsApiAxiosParamCreator(configuration?: Configuration): { getAttachment: (videoId: string, mediaSourceId: string, index: number, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/video-attachments-api.ts:29
VideoAttachmentsApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getAttachment: (videoId: string, mediaSourceId: string, index: number, options?: any) => Promise<RequestArgs> }
- getAttachment: (videoId: string, mediaSourceId: string, index: number, options?: any) => Promise<RequestArgs>
  - - (videoId: string, mediaSourceId: string, index: number, options?: any): Promise<RequestArgs>
    - summary
      Get video attachment.
      
      throws
      {RequiredError}
      
      Parameters
      - videoId: string
        Video ID.
      - mediaSourceId: string
        Media Source ID.
      - index: number
        Attachment Index.
      - options: any = {}
      Returns Promise<RequestArgs>

Const VideoAttachmentsApiFactory

VideoAttachmentsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getAttachment: any }

- Defined in generated-client/api/video-attachments-api.ts:103
VideoAttachmentsApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getAttachment: any }
- getAttachment:function
  - getAttachment(videoId: string, mediaSourceId: string, index: number, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/video-attachments-api.ts:115
    summary
    Get video attachment.
    
    throws
    {RequiredError}
    
    Parameters
    - videoId: string
      Video ID.
    - mediaSourceId: string
      Media Source ID.
    - index: number
      Attachment Index.
    - Optional options: any
    Returns AxiosPromise<any>

Const VideoAttachmentsApiFp

VideoAttachmentsApiFp(configuration?: Configuration): { getAttachment: any }

- Defined in generated-client/api/video-attachments-api.ts:80
VideoAttachmentsApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getAttachment: any }
- getAttachment:function
  - getAttachment(videoId: string, mediaSourceId: string, index: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/video-attachments-api.ts:92
    summary
    Get video attachment.
    
    throws
    {RequiredError}
    
    Parameters
    - videoId: string
      Video ID.
    - mediaSourceId: string
      Media Source ID.
    - index: number
      Attachment Index.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

Const VideoHlsApiAxiosParamCreator

VideoHlsApiAxiosParamCreator(configuration?: Configuration): { getLiveHlsStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, maxWidth?: number, maxHeight?: number, enableSubtitlesInManifest?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/video-hls-api.ts:31
VideoHlsApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getLiveHlsStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, maxWidth?: number, maxHeight?: number, enableSubtitlesInManifest?: boolean, options?: any) => Promise<RequestArgs> }
- getLiveHlsStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, maxWidth?: number, maxHeight?: number, enableSubtitlesInManifest?: boolean, options?: any) => Promise<RequestArgs>
  - - (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, maxWidth?: number, maxHeight?: number, enableSubtitlesInManifest?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Gets a hls live stream.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional container: string
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional mediaSourceId: string
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - Optional maxWidth: number
      - Optional maxHeight: number
      - Optional enableSubtitlesInManifest: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const VideoHlsApiFactory

VideoHlsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getLiveHlsStream: any }

- Defined in generated-client/api/video-hls-api.ts:404
VideoHlsApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getLiveHlsStream: any }
- getLiveHlsStream:function
  - getLiveHlsStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, maxWidth?: number, maxHeight?: number, enableSubtitlesInManifest?: boolean, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/video-hls-api.ts:465
    summary
    Gets a hls live stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional container: string
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional enableSubtitlesInManifest: boolean
    - Optional options: any
    Returns AxiosPromise<any>

Const VideoHlsApiFp

VideoHlsApiFp(configuration?: Configuration): { getLiveHlsStream: any }

- Defined in generated-client/api/video-hls-api.ts:332
VideoHlsApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getLiveHlsStream: any }
- getLiveHlsStream:function
  - getLiveHlsStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, maxWidth?: number, maxHeight?: number, enableSubtitlesInManifest?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/video-hls-api.ts:393
    summary
    Gets a hls live stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional container: string
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional maxWidth: number
    - Optional maxHeight: number
    - Optional enableSubtitlesInManifest: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>

Const VideosApiAxiosParamCreator

VideosApiAxiosParamCreator(configuration?: Configuration): { deleteAlternateSources: (itemId: string, options?: any) => Promise<RequestArgs>; getAdditionalPart: (itemId: string, userId?: string, options?: any) => Promise<RequestArgs>; getVideoStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getVideoStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headVideoStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headVideoStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; mergeVersions: (ids: string[], options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/videos-api.ts:35
VideosApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { deleteAlternateSources: (itemId: string, options?: any) => Promise<RequestArgs>; getAdditionalPart: (itemId: string, userId?: string, options?: any) => Promise<RequestArgs>; getVideoStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; getVideoStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headVideoStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; headVideoStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>; mergeVersions: (ids: string[], options?: any) => Promise<RequestArgs> }
- deleteAlternateSources: (itemId: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, options?: any): Promise<RequestArgs>
    - summary
      Removes alternate video sources.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - options: any = {}
      Returns Promise<RequestArgs>
- getAdditionalPart: (itemId: string, userId?: string, options?: any) => Promise<RequestArgs>
  - - (itemId: string, userId?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets additional parts for a video.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getVideoStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
  - - (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
    - summary
      Gets a video stream.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional container: string
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional mediaSourceId: string
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getVideoStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
  - - (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
    - summary
      Gets a video stream.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - container: string
        The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional mediaSourceId: string
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - options: any = {}
      Returns Promise<RequestArgs>
- headVideoStream: (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
  - - (itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
    - summary
      Gets a video stream.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - Optional container: string
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional mediaSourceId: string
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - options: any = {}
      Returns Promise<RequestArgs>
- headVideoStreamByContainer: (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any) => Promise<RequestArgs>
  - - (itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<RequestArgs>
    - summary
      Gets a video stream.
      
      throws
      {RequiredError}
      
      Parameters
      - itemId: string
        The item id.
      - container: string
        The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
      - Optional _static: boolean
      - Optional params: string
      - Optional tag: string
      - Optional deviceProfileId: string
      - Optional playSessionId: string
      - Optional segmentContainer: string
      - Optional segmentLength: number
      - Optional minSegments: number
      - Optional mediaSourceId: string
      - Optional deviceId: string
      - Optional audioCodec: string
      - Optional enableAutoStreamCopy: boolean
      - Optional allowVideoStreamCopy: boolean
      - Optional allowAudioStreamCopy: boolean
      - Optional breakOnNonKeyFrames: boolean
      - Optional audioSampleRate: number
      - Optional maxAudioBitDepth: number
      - Optional audioBitRate: number
      - Optional audioChannels: number
      - Optional maxAudioChannels: number
      - Optional profile: string
      - Optional level: string
      - Optional framerate: number
      - Optional maxFramerate: number
      - Optional copyTimestamps: boolean
      - Optional startTimeTicks: number
      - Optional width: number
      - Optional height: number
      - Optional videoBitRate: number
      - Optional subtitleStreamIndex: number
      - Optional subtitleMethod: SubtitleDeliveryMethod
      - Optional maxRefFrames: number
      - Optional maxVideoBitDepth: number
      - Optional requireAvc: boolean
      - Optional deInterlace: boolean
      - Optional requireNonAnamorphic: boolean
      - Optional transcodingMaxAudioChannels: number
      - Optional cpuCoreLimit: number
      - Optional liveStreamId: string
      - Optional enableMpegtsM2TsMode: boolean
      - Optional videoCodec: string
      - Optional subtitleCodec: string
      - Optional transcodeReasons: string
      - Optional audioStreamIndex: number
      - Optional videoStreamIndex: number
      - Optional context: EncodingContext
      - Optional streamOptions: {}
        [key: string]: string
      - options: any = {}
      Returns Promise<RequestArgs>
- mergeVersions: (ids: string[], options?: any) => Promise<RequestArgs>
  - - (ids: string[], options?: any): Promise<RequestArgs>
    - summary
      Merges videos into a single record.
      
      throws
      {RequiredError}
      
      Parameters
      - ids: string[]
        Item id list. This allows multiple, comma delimited.
      - options: any = {}
      Returns Promise<RequestArgs>

Const VideosApiFactory

VideosApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { deleteAlternateSources: any; getAdditionalPart: any; getVideoStream: any; getVideoStreamByContainer: any; headVideoStream: any; headVideoStreamByContainer: any; mergeVersions: any }

- Defined in generated-client/api/videos-api.ts:1537
VideosApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { deleteAlternateSources: any; getAdditionalPart: any; getVideoStream: any; getVideoStreamByContainer: any; headVideoStream: any; headVideoStreamByContainer: any; mergeVersions: any }
- deleteAlternateSources:function
  - deleteAlternateSources(itemId: string, options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/videos-api.ts:1547
    summary
    Removes alternate video sources.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional options: any
    Returns AxiosPromise<void>
- getAdditionalPart:function
  - getAdditionalPart(itemId: string, userId?: string, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/videos-api.ts:1558
    summary
    Gets additional parts for a video.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional userId: string
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>
- getVideoStream:function
  - getVideoStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/videos-api.ts:1616
    summary
    Gets a video stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional container: string
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns AxiosPromise<any>
- getVideoStreamByContainer:function
  - getVideoStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/videos-api.ts:1674
    summary
    Gets a video stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - container: string
      The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns AxiosPromise<any>
- headVideoStream:function
  - headVideoStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/videos-api.ts:1732
    summary
    Gets a video stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional container: string
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns AxiosPromise<any>
- headVideoStreamByContainer:function
  - headVideoStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): AxiosPromise<any>
  - - Defined in generated-client/api/videos-api.ts:1790
    summary
    Gets a video stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - container: string
      The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns AxiosPromise<any>
- mergeVersions:function
  - mergeVersions(ids: string[], options?: any): AxiosPromise<void>
  - - Defined in generated-client/api/videos-api.ts:1800
    summary
    Merges videos into a single record.
    
    throws
    {RequiredError}
    
    Parameters
    - ids: string[]
      Item id list. This allows multiple, comma delimited.
    - Optional options: any
    Returns AxiosPromise<void>

Const VideosApiFp

VideosApiFp(configuration?: Configuration): { deleteAlternateSources: any; getAdditionalPart: any; getVideoStream: any; getVideoStreamByContainer: any; headVideoStream: any; headVideoStreamByContainer: any; mergeVersions: any }

- Defined in generated-client/api/videos-api.ts:1257
VideosApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { deleteAlternateSources: any; getAdditionalPart: any; getVideoStream: any; getVideoStreamByContainer: any; headVideoStream: any; headVideoStreamByContainer: any; mergeVersions: any }
- deleteAlternateSources:function
  - deleteAlternateSources(itemId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/videos-api.ts:1267
    summary
    Removes alternate video sources.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
- getAdditionalPart:function
  - getAdditionalPart(itemId: string, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/videos-api.ts:1279
    summary
    Gets additional parts for a video.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
- getVideoStream:function
  - getVideoStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/videos-api.ts:1338
    summary
    Gets a video stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional container: string
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- getVideoStreamByContainer:function
  - getVideoStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/videos-api.ts:1397
    summary
    Gets a video stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - container: string
      The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headVideoStream:function
  - headVideoStream(itemId: string, container?: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/videos-api.ts:1456
    summary
    Gets a video stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - Optional container: string
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- headVideoStreamByContainer:function
  - headVideoStreamByContainer(itemId: string, container: string, _static?: boolean, params?: string, tag?: string, deviceProfileId?: string, playSessionId?: string, segmentContainer?: string, segmentLength?: number, minSegments?: number, mediaSourceId?: string, deviceId?: string, audioCodec?: string, enableAutoStreamCopy?: boolean, allowVideoStreamCopy?: boolean, allowAudioStreamCopy?: boolean, breakOnNonKeyFrames?: boolean, audioSampleRate?: number, maxAudioBitDepth?: number, audioBitRate?: number, audioChannels?: number, maxAudioChannels?: number, profile?: string, level?: string, framerate?: number, maxFramerate?: number, copyTimestamps?: boolean, startTimeTicks?: number, width?: number, height?: number, videoBitRate?: number, subtitleStreamIndex?: number, subtitleMethod?: SubtitleDeliveryMethod, maxRefFrames?: number, maxVideoBitDepth?: number, requireAvc?: boolean, deInterlace?: boolean, requireNonAnamorphic?: boolean, transcodingMaxAudioChannels?: number, cpuCoreLimit?: number, liveStreamId?: string, enableMpegtsM2TsMode?: boolean, videoCodec?: string, subtitleCodec?: string, transcodeReasons?: string, audioStreamIndex?: number, videoStreamIndex?: number, context?: EncodingContext, streamOptions?: {}, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
  - - Defined in generated-client/api/videos-api.ts:1515
    summary
    Gets a video stream.
    
    throws
    {RequiredError}
    
    Parameters
    - itemId: string
      The item id.
    - container: string
      The video container. Possible values are: ts, webm, asf, wmv, ogv, mp4, m4v, mkv, mpeg, mpg, avi, 3gp, wmv, wtv, m2ts, mov, iso, flv.
    - Optional _static: boolean
    - Optional params: string
    - Optional tag: string
    - Optional deviceProfileId: string
    - Optional playSessionId: string
    - Optional segmentContainer: string
    - Optional segmentLength: number
    - Optional minSegments: number
    - Optional mediaSourceId: string
    - Optional deviceId: string
    - Optional audioCodec: string
    - Optional enableAutoStreamCopy: boolean
    - Optional allowVideoStreamCopy: boolean
    - Optional allowAudioStreamCopy: boolean
    - Optional breakOnNonKeyFrames: boolean
    - Optional audioSampleRate: number
    - Optional maxAudioBitDepth: number
    - Optional audioBitRate: number
    - Optional audioChannels: number
    - Optional maxAudioChannels: number
    - Optional profile: string
    - Optional level: string
    - Optional framerate: number
    - Optional maxFramerate: number
    - Optional copyTimestamps: boolean
    - Optional startTimeTicks: number
    - Optional width: number
    - Optional height: number
    - Optional videoBitRate: number
    - Optional subtitleStreamIndex: number
    - Optional subtitleMethod: SubtitleDeliveryMethod
    - Optional maxRefFrames: number
    - Optional maxVideoBitDepth: number
    - Optional requireAvc: boolean
    - Optional deInterlace: boolean
    - Optional requireNonAnamorphic: boolean
    - Optional transcodingMaxAudioChannels: number
    - Optional cpuCoreLimit: number
    - Optional liveStreamId: string
    - Optional enableMpegtsM2TsMode: boolean
    - Optional videoCodec: string
    - Optional subtitleCodec: string
    - Optional transcodeReasons: string
    - Optional audioStreamIndex: number
    - Optional videoStreamIndex: number
    - Optional context: EncodingContext
    - Optional streamOptions: {}
      - [key: string]: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>
- mergeVersions:function
  - mergeVersions(ids: string[], options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>
  - - Defined in generated-client/api/videos-api.ts:1526
    summary
    Merges videos into a single record.
    
    throws
    {RequiredError}
    
    Parameters
    - ids: string[]
      Item id list. This allows multiple, comma delimited.
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

Const YearsApiAxiosParamCreator

YearsApiAxiosParamCreator(configuration?: Configuration): { getYear: (year: number, userId?: string, options?: any) => Promise<RequestArgs>; getYears: (startIndex?: number, limit?: number, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], mediaTypes?: string[], sortBy?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, recursive?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs> }

- Defined in generated-client/api/years-api.ts:39
YearsApi - axios parameter creator

export
Parameters
- Optional configuration: Configuration
Returns { getYear: (year: number, userId?: string, options?: any) => Promise<RequestArgs>; getYears: (startIndex?: number, limit?: number, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], mediaTypes?: string[], sortBy?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, recursive?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs> }
- getYear: (year: number, userId?: string, options?: any) => Promise<RequestArgs>
  - - (year: number, userId?: string, options?: any): Promise<RequestArgs>
    - summary
      Gets a year.
      
      throws
      {RequiredError}
      
      Parameters
      - year: number
        The year.
      - Optional userId: string
      - options: any = {}
      Returns Promise<RequestArgs>
- getYears: (startIndex?: number, limit?: number, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], mediaTypes?: string[], sortBy?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, recursive?: boolean, enableImages?: boolean, options?: any) => Promise<RequestArgs>
  - - (startIndex?: number, limit?: number, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], mediaTypes?: string[], sortBy?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, recursive?: boolean, enableImages?: boolean, options?: any): Promise<RequestArgs>
    - summary
      Get years.
      
      throws
      {RequiredError}
      
      Parameters
      - Optional startIndex: number
      - Optional limit: number
      - Optional sortOrder: SortOrder[]
      - Optional parentId: string
      - Optional fields: ItemFields[]
      - Optional excludeItemTypes: string[]
      - Optional includeItemTypes: string[]
      - Optional mediaTypes: string[]
      - Optional sortBy: string[]
      - Optional enableUserData: boolean
      - Optional imageTypeLimit: number
      - Optional enableImageTypes: ImageType[]
      - Optional userId: string
      - Optional recursive: boolean
      - Optional enableImages: boolean
      - options: any = {}
      Returns Promise<RequestArgs>

Const YearsApiFactory

YearsApiFactory(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): { getYear: any; getYears: any }

- Defined in generated-client/api/years-api.ts:245
YearsApi - factory interface

export
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns { getYear: any; getYears: any }
- getYear:function
  - getYear(year: number, userId?: string, options?: any): AxiosPromise<BaseItemDto>
  - - Defined in generated-client/api/years-api.ts:256
    summary
    Gets a year.
    
    throws
    {RequiredError}
    
    Parameters
    - year: number
      The year.
    - Optional userId: string
    - Optional options: any
    Returns AxiosPromise<BaseItemDto>
- getYears:function
  - getYears(startIndex?: number, limit?: number, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], mediaTypes?: string[], sortBy?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, recursive?: boolean, enableImages?: boolean, options?: any): AxiosPromise<BaseItemDtoQueryResult>
  - - Defined in generated-client/api/years-api.ts:280
    summary
    Get years.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional startIndex: number
    - Optional limit: number
    - Optional sortOrder: SortOrder[]
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional mediaTypes: string[]
    - Optional sortBy: string[]
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional userId: string
    - Optional recursive: boolean
    - Optional enableImages: boolean
    - Optional options: any
    Returns AxiosPromise<BaseItemDtoQueryResult>

Const YearsApiFp

YearsApiFp(configuration?: Configuration): { getYear: any; getYears: any }

- Defined in generated-client/api/years-api.ts:198
YearsApi - functional programming interface

export
Parameters
- Optional configuration: Configuration
Returns { getYear: any; getYears: any }
- getYear:function
  - getYear(year: number, userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
  - - Defined in generated-client/api/years-api.ts:209
    summary
    Gets a year.
    
    throws
    {RequiredError}
    
    Parameters
    - year: number
      The year.
    - Optional userId: string
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDto>>
- getYears:function
  - getYears(startIndex?: number, limit?: number, sortOrder?: SortOrder[], parentId?: string, fields?: ItemFields[], excludeItemTypes?: string[], includeItemTypes?: string[], mediaTypes?: string[], sortBy?: string[], enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], userId?: string, recursive?: boolean, enableImages?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>
  - - Defined in generated-client/api/years-api.ts:234
    summary
    Get years.
    
    throws
    {RequiredError}
    
    Parameters
    - Optional startIndex: number
    - Optional limit: number
    - Optional sortOrder: SortOrder[]
    - Optional parentId: string
    - Optional fields: ItemFields[]
    - Optional excludeItemTypes: string[]
    - Optional includeItemTypes: string[]
    - Optional mediaTypes: string[]
    - Optional sortBy: string[]
    - Optional enableUserData: boolean
    - Optional imageTypeLimit: number
    - Optional enableImageTypes: ImageType[]
    - Optional userId: string
    - Optional recursive: boolean
    - Optional enableImages: boolean
    - Optional options: any
    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BaseItemDtoQueryResult>>

Index

Enumerations

Classes

Interfaces

Functions

Functions

Const ActivityLogApiAxiosParamCreator

Parameters

Optional configuration: Configuration

Returns { getLogEntries: (startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: any) => Promise<RequestArgs> }

getLogEntries: (startIndex?: number, limit?: number, minDate?: string, hasUserId?: boolean, options?: any) => Promise<RequestArgs>

Parameters

Optional startIndex: number

Optional limit: number

Optional minDate: string

Optional hasUserId: boolean

options: any = {}

Returns Promise<RequestArgs>

Const ActivityLogApiFactory

Parameters

Optional configuration: Configuration

Optional basePath: string

Optional axios: AxiosInstance

Returns { getLogEntries: any }

getLogEntries:function

Parameters

Optional startIndex: number

Optional limit: number

Optional minDate: string

Optional hasUserId: boolean

Optional options: any

Returns AxiosPromise<ActivityLogEntryQueryResult>

Const ActivityLogApiFp

Parameters

Optional configuration: Configuration

Returns { getLogEntries: any }

getLogEntries:function

Parameters

Optional startIndex: number

Optional limit: number

Optional minDate: string

Optional hasUserId: boolean

Optional options: any

Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActivityLogEntryQueryResult>>

Const ApiKeyApiAxiosParamCreator

Parameters

Optional configuration: Configuration

Returns { createKey: (app: string, options?: any) => Promise<RequestArgs>; getKeys: (options?: any) => Promise<RequestArgs>; revokeKey: (key: string, options?: any) => Promise<RequestArgs> }

createKey: (app: string, options?: any) => Promise<RequestArgs>

Parameters

app: string

options: any = {}

Returns Promise<RequestArgs>

getKeys: (options?: any) => Promise<RequestArgs>

Parameters

options: any = {}

Returns Promise<RequestArgs>

revokeKey: (key: string, options?: any) => Promise<RequestArgs>

Parameters

key: string

options: any = {}

Returns Promise<RequestArgs>

Const ApiKeyApiFactory

Parameters

Optional configuration: Configuration

Optional basePath: string

Optional axios: AxiosInstance

Returns { createKey: any; getKeys: any; revokeKey: any }

createKey:function

Parameters

app: string

Optional options: any

Returns AxiosPromise<void>

getKeys:function

Parameters

Optional options: any

Returns AxiosPromise<AuthenticationInfoQueryResult>

revokeKey:function

Parameters

key: string